{"items":[{"type":"link","label":"Pioneer Loan Platform API","link":"/apis/public-api","routeSlug":"/apis/public-api","content":{"contentType":"overview","meta":{"name":"Pioneer Loan Platform API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"OpenAPI 3.1.0 description (YAML)","url":"/downloads/openapi-3.1.yaml"},{"kind":"download","label":"OpenAPI 3.1.0 description (JSON)","url":"/downloads/openapi-3.1.json"},{"kind":"download","label":"OpenAPI 3.0.3 description (YAML)","url":"/downloads/openapi.yaml"},{"kind":"download","label":"OpenAPI 3.0.3 description (JSON)","url":"/downloads/openapi.json"},{"kind":"download","label":"Postman collection","url":"/downloads/pioneer-api.postman_collection.json"},{"kind":"download","label":"Postman environment — Staging","url":"/downloads/pioneer-api.staging.postman_environment.json"},{"kind":"download","label":"Postman environment — Production","url":"/downloads/pioneer-api.production.postman_environment.json"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.pioneerft.com","url":"https://www.pioneerft.com"},{"kind":"email","title":"Pioneer Support","email":"contact@pioneerft.com","label":"contact@pioneerft.com","withCopyButton":true,"copyContent":"contact@pioneerft.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://pioneerft.com/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Pioneer Loan Platform API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis/public-api"}],"sectionId":"/apis/public-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/pioneer-public-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pioneer Public API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Pioneer API allows third-party systems to programmatically access loan data,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documents, and related entities."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/url-structure"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL Structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API requests use environment-specific domains (following existing portal pattern):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Production:  https://{api-portal}.{bank-domain}/api/public/v1/{resource}\nStaging:     https://{api-portal}.staging.{bank-domain}/api/public/v1/{resource}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Production:  https://{api-portal}.{bank-domain}/api/public/v1/{resource}\nStaging:     https://{api-portal}.staging.{bank-domain}/api/public/v1/{resource}\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.pioneerft.com/api/public/v1/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pk_live_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Staging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.pioneerft.com/api/public/v1/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pk_test_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys)"},"children":[]}]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/url-structure"}],"sectionId":"/apis/public-api/section/pioneer-public-api/url-structure"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current version is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", served under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/public/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path prefix."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legacy unversioned path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/public/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" still works but is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responses include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deprecation: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sunset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Migrate to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/public/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/versioning"}],"sectionId":"/apis/public-api/section/pioneer-public-api/versioning"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests require authentication using an API key. Include your API key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer pk_live_your_api_key_here\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer pk_live_your_api_key_here\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pk_test_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Test keys (only work on staging URLs)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pk_live_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Live keys (only work on production URLs - no env prefix)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys can be generated in the Pioneer dashboard under Organization Settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Production keys require explicit approval from Pioneer."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/authentication"}],"sectionId":"/apis/public-api/section/pioneer-public-api/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits are applied per API key, with separate budgets for reads and writes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (GET): "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100 requests per minute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Writes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (POST/PATCH/DELETE): "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 requests per minute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per API key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit information is included in response headers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Maximum requests per window"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Remaining"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Requests remaining in current window"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unix timestamp when window resets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When rate limited, you'll receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header indicating seconds to wait."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Production API keys ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pk_live_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that exceed rate limits"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 or more times within 24 hours will be automatically revoked, and your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"organization's production API access will be disabled. Contact Pioneer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"support to re-enable access."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/rate-limiting"}],"sectionId":"/apis/public-api/section/pioneer-public-api/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/idempotency"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotency"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write requests (POST/PATCH/DELETE) accept an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(any opaque string up to 255 chars; a UUID is recommended). Replaying a request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the same key returns the original response instead of repeating the side"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effect."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/idempotency"}],"sectionId":"/apis/public-api/section/pioneer-public-api/idempotency"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List endpoints support pagination via query parameters:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Number of items to return (default: 50, max: 100)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Number of items to skip"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response includes pagination metadata. Offset-mode responses look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"data\": [],\n  \"meta\": {\n    \"mode\": \"offset\",\n    \"limit\": 50,\n    \"offset\": 0,\n    \"hasMore\": true\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"data\": [],\n  \"meta\": {\n    \"mode\": \"offset\",\n    \"limit\": 50,\n    \"offset\": 0,\n    \"hasMore\": true\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor-mode responses (returned when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query param is supplied) instead"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"mode\": \"cursor\", \"limit\": 50, \"hasMore\": true, \"nextCursor\": \"<token>\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an opaque token (null when there are no more results). Pass"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it back as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query param to fetch the next page. Offset and cursor are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mutually exclusive, and cursor mode always orders by creation time."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/pagination"}],"sectionId":"/apis/public-api/section/pioneer-public-api/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors are returned with appropriate HTTP status codes and JSON body:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"code\": \"auth.invalid_key\",\n  \"message\": \"Invalid or expired API key\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"code\": \"auth.invalid_key\",\n  \"message\": \"Invalid or expired API key\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common error codes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth.invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": API key is invalid or expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth.org_mismatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": API key does not belong to the organization in the URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth.env_mismatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": API key type does not match URL environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth.env_not_available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Environment not available for this organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth.insufficient_permissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": API key lacks required permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth.country_restricted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Request IP not allowed for this API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key.production_not_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Organization not approved for production API keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"input.invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Request validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limit.exceeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Too many requests"},"children":[]}]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/errors"}],"sectionId":"/apis/public-api/section/pioneer-public-api/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/openapi-document"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI document"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The spec is published in two OpenAPI versions, both under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download OpenAPI"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and each in YAML and JSON. They are generated from the same routes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the same run, describe the identical API, and differ only in schema dialect."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI 3.1.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the current one. It uses JSON Schema 2020-12:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: [..., \"null\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for nullables and numeric"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclusiveMinimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclusiveMaximum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI 3.0.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for tooling that does not read 3.1 — the same document with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nullable: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and boolean "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclusive*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. It is also what the Postman"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection is generated from. 3.0.3 is the last patch of the 3.0 line; a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumer pinned to 3.0.0, 3.0.1 or 3.0.2 reads it without changes, since those"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"patches clarify the specification rather than alter the document format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your generator supports both, take 3.1.0."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/openapi-document"}],"sectionId":"/apis/public-api/section/pioneer-public-api/openapi-document"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pioneer-public-api/api-clients"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ready-to-import clients are generated from these same routes in the same run, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they never drift from the live API. Both are listed under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download OpenAPI"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" above, next to the spec itself."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Import the collection plus the environment for your target"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Staging or Production), then set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to your key — every request inherits"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection-level bearer auth. Path parameters such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appear as editable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields under the URL bar, and optional query parameters are pre-filled but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, so tick only the ones you need."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Insomnia."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Imports OpenAPI directly: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> choose the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI 3.0.3 YAML. Set the base environment's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the environment you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are targeting and add your key as a bearer token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Need access or a key? "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.pioneerft.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/section/pioneer-public-api/api-clients"}],"sectionId":"/apis/public-api/section/pioneer-public-api/api-clients"}]}]}},{"type":"group","label":"Pioneer Public API","link":"/apis/public-api/section/pioneer-public-api","routeSlug":"/apis/public-api/section/pioneer-public-api","items":[{"type":"link","label":"URL Structure","link":"/apis/public-api/section/pioneer-public-api/url-structure","routeSlug":"/apis/public-api/section/pioneer-public-api/url-structure","content":null},{"type":"link","label":"Versioning","link":"/apis/public-api/section/pioneer-public-api/versioning","routeSlug":"/apis/public-api/section/pioneer-public-api/versioning","content":null},{"type":"link","label":"Authentication","link":"/apis/public-api/section/pioneer-public-api/authentication","routeSlug":"/apis/public-api/section/pioneer-public-api/authentication","content":null},{"type":"link","label":"Rate Limiting","link":"/apis/public-api/section/pioneer-public-api/rate-limiting","routeSlug":"/apis/public-api/section/pioneer-public-api/rate-limiting","content":null},{"type":"link","label":"Idempotency","link":"/apis/public-api/section/pioneer-public-api/idempotency","routeSlug":"/apis/public-api/section/pioneer-public-api/idempotency","content":null},{"type":"link","label":"Pagination","link":"/apis/public-api/section/pioneer-public-api/pagination","routeSlug":"/apis/public-api/section/pioneer-public-api/pagination","content":null},{"type":"link","label":"Errors","link":"/apis/public-api/section/pioneer-public-api/errors","routeSlug":"/apis/public-api/section/pioneer-public-api/errors","content":null},{"type":"link","label":"OpenAPI document","link":"/apis/public-api/section/pioneer-public-api/openapi-document","routeSlug":"/apis/public-api/section/pioneer-public-api/openapi-document","content":null},{"type":"link","label":"API clients","link":"/apis/public-api/section/pioneer-public-api/api-clients","routeSlug":"/apis/public-api/section/pioneer-public-api/api-clients","content":null}],"content":null},{"type":"group","label":"Loans","link":"/apis/public-api/loans","routeSlug":"/apis/public-api/loans","items":[{"label":"List loans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/listloans","routeSlug":"/apis/public-api/loans/listloans","metadata":{"seo":{"title":"List loans","description":"Retrieve a paginated list of loans. Supports filtering by status and product ID. Returns loan summary information without sensitive details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoans","name":"List loans","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of loans. Supports filtering by status and product ID. Returns loan summary information without sensitive details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"},{"name":"status","in":"query","schemaId":"schema_73"},{"name":"productId","in":"query","schemaId":"schema_72"},{"name":"sort","in":"query","schemaId":"schema_74"},{"name":"order","in":"query","schemaId":"schema_75"}],"pointer":"/paths/~1public~1v1~1loans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"},{"name":"status","in":"query","schemaId":"schema_73"},{"name":"productId","in":"query","schemaId":"schema_72"},{"name":"sort","in":"query","schemaId":"schema_74"},{"name":"order","in":"query","schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/public/v1/loans","href":"loans/listloans","openApiOperationId":"listLoans","summary":"List loans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with list of loans","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76"}},"schemaId":"schema_76"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_76","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/listloans"}],"panels":[]}]},"httpPath":"/public/v1/loans"},{"label":"List loans ready to board","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/listboardingqueue","routeSlug":"/apis/public-api/loans/listboardingqueue","metadata":{"seo":{"title":"List loans ready to board","description":"Loans a banker released to the core and nobody has boarded yet, oldest first. A loan reaches this queue only once a banker releases it — being funded is not enough on its own. Acknowledge a board with POST /loans/{id}/boarding and the loan leaves the queue, so a scheduled pull only ever returns work that is still outstanding: a board that failed on your side simply stays. Pass boarded=true (optionally with boardedSince) to reconcile instead — the loans already boarded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBoardingQueue","name":"List loans ready to board","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1boarding-queue/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loans ready to board","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans a banker released to the core and nobody has boarded yet, oldest first. A loan reaches this queue only once a banker releases it — being funded is not enough on its own. Acknowledge a board with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /loans/{id}/boarding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the loan leaves the queue, so a scheduled pull only ever returns work that is still outstanding: a board that failed on your side simply stays. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"boarded=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optionally with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"boardedSince"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to reconcile instead — the loans already boarded."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"},{"name":"boarded","in":"query","schemaId":"schema_81"},{"name":"boardedSince","in":"query","schemaId":"schema_72"}],"pointer":"/paths/~1public~1v1~1loans~1boarding-queue/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/boarding-queue","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"},{"name":"boarded","in":"query","schemaId":"schema_81"},{"name":"boardedSince","in":"query","schemaId":"schema_72"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/public/v1/loans/boarding-queue","href":"loans/listboardingqueue","openApiOperationId":"listBoardingQueue","summary":"List loans ready to board"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loans ready to board (or already boarded)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1boarding-queue/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/listboardingqueue"}],"panels":[]}]},"httpPath":"/public/v1/loans/boarding-queue"},{"label":"Get loan details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/getloan","routeSlug":"/apis/public-api/loans/getloan","metadata":{"seo":{"title":"Get loan details","description":"Retrieve detailed information about a specific loan by ID. Returns loan terms, amounts, dates, and status without exposing sensitive internal data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoan","name":"Get loan details","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve detailed information about a specific loan by ID. Returns loan terms, amounts, dates, and status without exposing sensitive internal data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}","href":"loans/getloan","openApiOperationId":"getLoan","summary":"Get loan details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with loan details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}},"schemaId":"schema_83"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_83","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/getloan"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}"},{"label":"Update a loan","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/updateloan","routeSlug":"/apis/public-api/loans/updateloan","metadata":{"seo":{"title":"Update a loan","description":"Update loan fields. Money is in whole cents (centsAmount: 50000000 is $500,000.00) and rates in basis points (bpsFixedRate: 525 is 5.25%). Only allowlisted fields can be updated — server-managed fields like status and stage are excluded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLoan","name":"Update a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update loan fields. Money is in whole cents ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"centsAmount: 50000000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is $500,000.00) and rates in basis points ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bpsFixedRate: 525"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 5.25%). Only allowlisted fields can be updated — server-managed fields like status and stage are excluded."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_85"}},"schemaId":"schema_85","pointer":"/paths/~1public~1v1~1loans~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/loans/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_85"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}","href":"loans/updateloan","openApiOperationId":"updateLoan","summary":"Update a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_85","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_85"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}},"schemaId":"schema_83"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_83","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/updateloan"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}"},{"label":"Archive a loan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/deleteloan","routeSlug":"/apis/public-api/loans/deleteloan","metadata":{"seo":{"title":"Archive a loan","description":"Soft-delete a loan by setting its deletion timestamp. The loan will no longer appear in list results but can be restored by Pioneer support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLoan","name":"Archive a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Soft-delete a loan by setting its deletion timestamp. The loan will no longer appear in list results but can be restored by Pioneer support."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/loans/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}","href":"loans/deleteloan","openApiOperationId":"deleteLoan","summary":"Archive a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan archived successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}},"schemaId":"schema_86"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_86","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/deleteloan"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}"},{"label":"Get loan summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/getloansummary","routeSlug":"/apis/public-api/loans/getloansummary","metadata":{"seo":{"title":"Get loan summary","description":"Retrieve a summary of a loan including key metrics like total amount, monthly payment, term, and activity status (open tasks, message activity). hasMessages reflects non-internal (customer/broker-visible) conversation only — internal banker threads are never exposed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoanSummary","name":"Get loan summary","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a summary of a loan including key metrics like total amount, monthly payment, term, and activity status (open tasks, message activity). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasMessages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflects non-internal (customer/broker-visible) conversation only — internal banker threads are never exposed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/summary","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/summary","href":"loans/getloansummary","openApiOperationId":"getLoanSummary","summary":"Get loan summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with loan summary","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_87"}},"schemaId":"schema_87"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_87","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_87"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/getloansummary"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/summary"},{"label":"Get loan entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/getloanentities","routeSlug":"/apis/public-api/loans/getloanentities","metadata":{"seo":{"title":"Get loan entities","description":"Retrieve businesses and people associated with a loan. Returns entity names, types, and roles. Sensitive data like full SSN/EIN is excluded (only last 4 digits shown)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoanEntities","name":"Get loan entities","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1entities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve businesses and people associated with a loan. Returns entity names, types, and roles. Sensitive data like full SSN/EIN is excluded (only last 4 digits shown)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1entities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/entities","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/entities","href":"loans/getloanentities","openApiOperationId":"getLoanEntities","summary":"Get loan entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with loan entities","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88"}},"schemaId":"schema_88"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1entities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_88","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/getloanentities"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/entities"},{"label":"Search loans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/searchloans","routeSlug":"/apis/public-api/loans/searchloans","metadata":{"seo":{"title":"Search loans","description":"Advanced loan search with complex filtering capabilities. Supports multiple status filters, date ranges, amount ranges (in whole cents), and custom sorting. Use this endpoint when you need more control than the basic list endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchLoans","name":"Search loans","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search loans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Advanced loan search with complex filtering capabilities. Supports multiple status filters, date ranges, amount ranges (in whole cents), and custom sorting. Use this endpoint when you need more control than the basic list endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_89"}},"schemaId":"schema_89","pointer":"/paths/~1public~1v1~1loans~1search/post/requestBody","description":"Search criteria"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/search","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_89"}},"responseCodes":["200","400","401","403","429"],"pointer":"/public/v1/loans/search","href":"loans/searchloans","openApiOperationId":"searchLoans","summary":"Search loans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_89","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_89"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with search results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76"}},"schemaId":"schema_76"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_76","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/searchloans"}],"panels":[]}]},"httpPath":"/public/v1/loans/search"},{"label":"Get loan status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/getloanstatus","routeSlug":"/apis/public-api/loans/getloanstatus","metadata":{"seo":{"title":"Get loan status","description":"Get a loan's current status and stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoanStatus","name":"Get loan status","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a loan's current status and stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/status","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/status","href":"loans/getloanstatus","openApiOperationId":"getLoanStatus","summary":"Get loan status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current loan status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90"}},"schemaId":"schema_90"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_90","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/getloanstatus"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/status"},{"label":"Get loan status timeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/getloantimeline","routeSlug":"/apis/public-api/loans/getloantimeline","metadata":{"seo":{"title":"Get loan status timeline","description":"Get the loan's status-transition history (most recent first), sourced from the audit log."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoanTimeline","name":"Get loan status timeline","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1timeline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan status timeline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the loan's status-transition history (most recent first), sourced from the audit log."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/timeline","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/timeline","href":"loans/getloantimeline","openApiOperationId":"getLoanTimeline","summary":"Get loan status timeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan status timeline","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91"}},"schemaId":"schema_91"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_91","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/getloantimeline"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/timeline"},{"label":"Get a loan's boarding state","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/getloanboarding","routeSlug":"/apis/public-api/loans/getloanboarding","metadata":{"seo":{"title":"Get a loan's boarding state","description":"Whether a banker released the loan to the core, who released it and when, and whether the core has acknowledged the board."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoanBoarding","name":"Get a loan's boarding state","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a loan's boarding state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Whether a banker released the loan to the core, who released it and when, and whether the core has acknowledged the board."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/boarding","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/boarding","href":"loans/getloanboarding","openApiOperationId":"getLoanBoarding","summary":"Get a loan's boarding state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Boarding state","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}},"schemaId":"schema_92"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_92","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/getloanboarding"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/boarding"},{"label":"Acknowledge a board","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/loans/acknowledgeloanboarding","routeSlug":"/apis/public-api/loans/acknowledgeloanboarding","metadata":{"seo":{"title":"Acknowledge a board","description":"Record that the core boarded the loan. The loan leaves the boarding queue and the event is audited. Only a loan a banker released can be acknowledged — a loan that never reached the queue returns 400. Safe to repeat: a second call returns the boarding that already stands rather than overwriting it, so a retry after a lost response cannot rewrite when the core boarded the loan. Send coreRecordNumber to store the core’s own identifier for the loan on the Pioneer record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acknowledgeLoanBoarding","name":"Acknowledge a board","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge a board","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record that the core boarded the loan. The loan leaves the boarding queue and the event is audited. Only a loan a banker released can be acknowledged — a loan that never reached the queue returns 400. Safe to repeat: a second call returns the boarding that already stands rather than overwriting it, so a retry after a lost response cannot rewrite when the core boarded the loan. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coreRecordNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to store the core’s own identifier for the loan on the Pioneer record."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94","pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/{id}/boarding","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_94"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/boarding","href":"loans/acknowledgeloanboarding","openApiOperationId":"acknowledgeLoanBoarding","summary":"Acknowledge a board"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_94"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Boarding recorded (or already recorded)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}},"schemaId":"schema_92"},{"code":"400","description":"The loan was never released to the core, so it is not in the queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}},"schemaId":"schema_95"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1boarding/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_92","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}}},{"code":"400","schemaId":"schema_95","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/acknowledgeloanboarding"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/boarding"}],"content":{"contentType":"group","meta":{"name":"Loans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loans","showPageActions":true},{"nodeType":"markdoc","content":"Access and update loan data including details, summaries, status, and entities"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans","summary":"List loans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/listloans","deprecated":false},{"title":"/public/v1/loans/boarding-queue","summary":"List loans ready to board","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/listboardingqueue","deprecated":false},{"title":"/public/v1/loans/{id}","summary":"Get loan details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/getloan","deprecated":false},{"title":"/public/v1/loans/{id}","summary":"Update a loan","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/loans/updateloan","deprecated":false},{"title":"/public/v1/loans/{id}","summary":"Archive a loan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loans/deleteloan","deprecated":false},{"title":"/public/v1/loans/{id}/summary","summary":"Get loan summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/getloansummary","deprecated":false},{"title":"/public/v1/loans/{id}/entities","summary":"Get loan entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/getloanentities","deprecated":false},{"title":"/public/v1/loans/search","summary":"Search loans","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/searchloans","deprecated":false},{"title":"/public/v1/loans/{id}/status","summary":"Get loan status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/getloanstatus","deprecated":false},{"title":"/public/v1/loans/{id}/timeline","summary":"Get loan status timeline","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/getloantimeline","deprecated":false},{"title":"/public/v1/loans/{id}/boarding","summary":"Get a loan's boarding state","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/getloanboarding","deprecated":false},{"title":"/public/v1/loans/{id}/boarding","summary":"Acknowledge a board","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/acknowledgeloanboarding","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/apis/public-api/tasks","routeSlug":"/apis/public-api/tasks","items":[{"label":"List loan tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/tasks/listloantasks","routeSlug":"/apis/public-api/tasks/listloantasks","metadata":{"seo":{"title":"List loan tasks","description":"List the workflow tasks (submit / pre-approve / approve / re-submit steps) for a loan, with open/completed status. Read-only: tasks are completed automatically by the loan workflow/decision engine when the corresponding action occurs, not via a direct API write."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanTasks","name":"List loan tasks","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loan tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the workflow tasks (submit / pre-approve / approve / re-submit steps) for a loan, with open/completed status. Read-only: tasks are completed automatically by the loan workflow/decision engine when the corresponding action occurs, not via a direct API write."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/tasks","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/tasks","href":"tasks/listloantasks","openApiOperationId":"listLoanTasks","summary":"List loan tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan tasks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/listloantasks"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/tasks"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read a loan’s workflow approval tasks"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/tasks","summary":"List loan tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/listloantasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Decisions","link":"/apis/public-api/decisions","routeSlug":"/apis/public-api/decisions","items":[{"label":"List underwriting decisions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/decisions/listloandecisions","routeSlug":"/apis/public-api/decisions/listloandecisions","metadata":{"seo":{"title":"List underwriting decisions","description":"List the per-product underwriting decisions for a loan. Returns the verdict (approved/declined) and, for declines, the reason. Raw rule internals and applicant data are never exposed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanDecisions","name":"List underwriting decisions","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1decisions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List underwriting decisions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the per-product underwriting decisions for a loan. Returns the verdict (approved/declined) and, for declines, the reason. Raw rule internals and applicant data are never exposed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1decisions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/decisions","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/decisions","href":"decisions/listloandecisions","openApiOperationId":"listLoanDecisions","summary":"List underwriting decisions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan underwriting decisions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_97"}},"schemaId":"schema_97"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1decisions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_97","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_97"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decisions/listloandecisions"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/decisions"}],"content":{"contentType":"group","meta":{"name":"Decisions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decisions","showPageActions":true},{"nodeType":"markdoc","content":"Read per-product underwriting decisions for a loan"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/decisions","summary":"List underwriting decisions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decisions/listloandecisions","deprecated":false}]}]}]}]}},{"type":"group","label":"Disbursements","link":"/apis/public-api/disbursements","routeSlug":"/apis/public-api/disbursements","items":[{"label":"List loan disbursements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/disbursements/listloandisbursements","routeSlug":"/apis/public-api/disbursements/listloandisbursements","metadata":{"seo":{"title":"List loan disbursements","description":"Retrieve the disbursements recorded against a loan, including amounts (in whole cents), recipients, payment methods, and status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanDisbursements","name":"List loan disbursements","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loan disbursements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the disbursements recorded against a loan, including amounts (in whole cents), recipients, payment methods, and status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/disbursements","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/disbursements","href":"disbursements/listloandisbursements","openApiOperationId":"listLoanDisbursements","summary":"List loan disbursements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan disbursements","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_98"}},"schemaId":"schema_98"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_98","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_98"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disbursements/listloandisbursements"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/disbursements"},{"label":"Create a disbursement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/disbursements/createdisbursement","routeSlug":"/apis/public-api/disbursements/createdisbursement","metadata":{"seo":{"title":"Create a disbursement","description":"Create a disbursement on a loan. centsAmount is in whole cents — 50000000 is $500,000.00."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDisbursement","name":"Create a disbursement","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a disbursement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a disbursement on a loan. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"centsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in whole cents — 50000000 is $500,000.00."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99"}},"schemaId":"schema_99","pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/{id}/disbursements","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_99"}},"responseCodes":["201","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/disbursements","href":"disbursements/createdisbursement","openApiOperationId":"createDisbursement","summary":"Create a disbursement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_99","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Disbursement created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1disbursements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disbursements/createdisbursement"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/disbursements"},{"label":"List GL accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/disbursements/listglaccounts","routeSlug":"/apis/public-api/disbursements/listglaccounts","metadata":{"seo":{"title":"List GL accounts","description":"List the organization’s general-ledger accounts. Returns active accounts by default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGlAccounts","name":"List GL accounts","isWebhook":false,"pointer":"/paths/~1public~1v1~1gl-accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List GL accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the organization’s general-ledger accounts. Returns active accounts by default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_101"},{"name":"search","in":"query","schemaId":"schema_102"},{"name":"includeInactive","in":"query","schemaId":"schema_103"}],"pointer":"/paths/~1public~1v1~1gl-accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/gl-accounts","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_101"},{"name":"search","in":"query","schemaId":"schema_102"},{"name":"includeInactive","in":"query","schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/public/v1/gl-accounts","href":"disbursements/listglaccounts","openApiOperationId":"listGlAccounts","summary":"List GL accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"GL accounts","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1gl-accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disbursements/listglaccounts"}],"panels":[]}]},"httpPath":"/public/v1/gl-accounts"},{"label":"Update a disbursement","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/disbursements/updatedisbursement","routeSlug":"/apis/public-api/disbursements/updatedisbursement","metadata":{"seo":{"title":"Update a disbursement","description":"Update an existing disbursement on a loan. Only the fields provided in the request body are changed; centsAmount is in whole cents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDisbursement","name":"Update a disbursement","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1disbursements~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a disbursement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing disbursement on a loan. Only the fields provided in the request body are changed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"centsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in whole cents."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanId","in":"path","schemaId":"schema_72","required":true},{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1disbursements~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1disbursements~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_105"}},"schemaId":"schema_105","pointer":"/paths/~1public~1v1~1loans~1{loanId}~1disbursements~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/loans/{loanId}/disbursements/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"loanId","in":"path","required":true,"schemaId":"schema_72"},{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_105"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{loanId}/disbursements/{id}","href":"disbursements/updatedisbursement","openApiOperationId":"updateDisbursement","summary":"Update a disbursement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_105","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_105"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Disbursement updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1disbursements~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disbursements/updatedisbursement"}],"panels":[]}]},"httpPath":"/public/v1/loans/{loanId}/disbursements/{id}"}],"content":{"contentType":"group","meta":{"name":"Disbursements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disbursements","showPageActions":true},{"nodeType":"markdoc","content":"List and manage loan disbursements (amounts in whole cents)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/disbursements","summary":"List loan disbursements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disbursements/listloandisbursements","deprecated":false},{"title":"/public/v1/loans/{id}/disbursements","summary":"Create a disbursement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disbursements/createdisbursement","deprecated":false},{"title":"/public/v1/gl-accounts","summary":"List GL accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disbursements/listglaccounts","deprecated":false},{"title":"/public/v1/loans/{loanId}/disbursements/{id}","summary":"Update a disbursement","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/disbursements/updatedisbursement","deprecated":false}]}]}]}]}},{"type":"group","label":"Collateral","link":"/apis/public-api/collateral","routeSlug":"/apis/public-api/collateral","items":[{"label":"List loan collateral","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/collateral/listloancollateral","routeSlug":"/apis/public-api/collateral/listloancollateral","metadata":{"seo":{"title":"List loan collateral","description":"Retrieve the collateral items securing a loan, including descriptions, values (in whole cents), advance rate (in basis points), and types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanCollateral","name":"List loan collateral","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loan collateral","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the collateral items securing a loan, including descriptions, values (in whole cents), advance rate (in basis points), and types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/collateral","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/collateral","href":"collateral/listloancollateral","openApiOperationId":"listLoanCollateral","summary":"List loan collateral"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan collateral","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collateral/listloancollateral"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/collateral"},{"label":"Add collateral to a loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/collateral/createcollateral","routeSlug":"/apis/public-api/collateral/createcollateral","metadata":{"seo":{"title":"Add collateral to a loan","description":"Add collateral to a loan. Money is in whole cents and bpsAdvanceRate is in basis points (8500 = 85%)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCollateral","name":"Add collateral to a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add collateral to a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add collateral to a loan. Money is in whole cents and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bpsAdvanceRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in basis points (8500 = 85%)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/{id}/collateral","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["201","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/collateral","href":"collateral/createcollateral","openApiOperationId":"createCollateral","summary":"Add collateral to a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Collateral created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1collateral/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collateral/createcollateral"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/collateral"},{"label":"Update collateral","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/collateral/updatecollateral","routeSlug":"/apis/public-api/collateral/updatecollateral","metadata":{"seo":{"title":"Update collateral","description":"Update collateral. Money is in whole cents and bpsAdvanceRate is in basis points (8500 = 85%)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCollateral","name":"Update collateral","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1collateral~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update collateral","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update collateral. Money is in whole cents and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bpsAdvanceRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in basis points (8500 = 85%)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanId","in":"path","schemaId":"schema_72","required":true},{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1collateral~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1collateral~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/~1public~1v1~1loans~1{loanId}~1collateral~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/loans/{loanId}/collateral/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"loanId","in":"path","required":true,"schemaId":"schema_72"},{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{loanId}/collateral/{id}","href":"collateral/updatecollateral","openApiOperationId":"updateCollateral","summary":"Update collateral"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Collateral updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1collateral~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collateral/updatecollateral"}],"panels":[]}]},"httpPath":"/public/v1/loans/{loanId}/collateral/{id}"}],"content":{"contentType":"group","meta":{"name":"Collateral"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collateral","showPageActions":true},{"nodeType":"markdoc","content":"List and manage loan collateral (cents for money, basis points for rates)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/collateral","summary":"List loan collateral","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collateral/listloancollateral","deprecated":false},{"title":"/public/v1/loans/{id}/collateral","summary":"Add collateral to a loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collateral/createcollateral","deprecated":false},{"title":"/public/v1/loans/{loanId}/collateral/{id}","summary":"Update collateral","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/collateral/updatecollateral","deprecated":false}]}]}]}]}},{"type":"group","label":"Debt","link":"/apis/public-api/debt","routeSlug":"/apis/public-api/debt","items":[{"label":"List loan debt schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/debt/listloandebt","routeSlug":"/apis/public-api/debt/listloandebt","metadata":{"seo":{"title":"List loan debt schedule","description":"List a loan's debt schedule (read-only). Debt records are synced from the loan's components/underwriting data and are not editable row-by-row via the API; money is in whole cents and bpsInterestRate is in basis points."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanDebt","name":"List loan debt schedule","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1debt/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loan debt schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List a loan's debt schedule (read-only). Debt records are synced from the loan's components/underwriting data and are not editable row-by-row via the API; money is in whole cents and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bpsInterestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in basis points."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1debt/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/debt","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/debt","href":"debt/listloandebt","openApiOperationId":"listLoanDebt","summary":"List loan debt schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan debt schedule","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109"}},"schemaId":"schema_109"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1debt/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_109","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debt/listloandebt"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/debt"}],"content":{"contentType":"group","meta":{"name":"Debt"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Debt","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read a loan’s debt schedule (read-only)"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/debt","summary":"List loan debt schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debt/listloandebt","deprecated":false}]}]}]}]}},{"type":"group","label":"Entities","link":"/apis/public-api/entities","routeSlug":"/apis/public-api/entities","items":[{"label":"Get a business","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/entities/getbusiness","routeSlug":"/apis/public-api/entities/getbusiness","metadata":{"seo":{"title":"Get a business","description":"Retrieve full details for a business, including its addresses. The EIN is returned masked (einLast4) unless the API key also holds the read:businesses:ein scope, in which case the full value is returned in ein. A null ein with a non-null einLast4 means the key lacks that scope; both null means no EIN is on record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusiness","name":"Get a business","isWebhook":false,"pointer":"/paths/~1public~1v1~1businesses~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve full details for a business, including its addresses. The EIN is returned masked ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einLast4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") unless the API key also holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read:businesses:ein"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope, in which case the full value is returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ein"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ein"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a non-null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einLast4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the key lacks that scope; both null means no EIN is on record."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1businesses~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/businesses/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/businesses/{id}","href":"entities/getbusiness","openApiOperationId":"getBusiness","summary":"Get a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with business detail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110"}},"schemaId":"schema_110"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1businesses~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_110","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entities/getbusiness"}],"panels":[]}]},"httpPath":"/public/v1/businesses/{id}"},{"label":"Get a person","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/entities/getperson","routeSlug":"/apis/public-api/entities/getperson","metadata":{"seo":{"title":"Get a person","description":"Retrieve full details for a person, including their addresses. The SSN is returned masked (ssnLast4) unless the API key also holds the read:people:ssn scope, in which case the full value is returned in ssn."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPerson","name":"Get a person","isWebhook":false,"pointer":"/paths/~1public~1v1~1people~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a person","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve full details for a person, including their addresses. The SSN is returned masked ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssnLast4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") unless the API key also holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read:people:ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope, in which case the full value is returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1people~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/people/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/people/{id}","href":"entities/getperson","openApiOperationId":"getPerson","summary":"Get a person"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with person detail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1people~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entities/getperson"}],"panels":[]}]},"httpPath":"/public/v1/people/{id}"},{"label":"Create a business on a loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/entities/createloanbusiness","routeSlug":"/apis/public-api/entities/createloanbusiness","metadata":{"seo":{"title":"Create a business on a loan","description":"Create a business and attach it to the loan with the given role (e.g. \"borrower\", \"guarantor\"). Accepts a full EIN; only the last 4 digits are ever returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLoanBusiness","name":"Create a business on a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1businesses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a business on a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a business and attach it to the loan with the given role (e.g. \"borrower\", \"guarantor\"). Accepts a full EIN; only the last 4 digits are ever returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1businesses/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1businesses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112","pointer":"/paths/~1public~1v1~1loans~1{id}~1businesses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/{id}/businesses","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_112"}},"responseCodes":["201","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/businesses","href":"entities/createloanbusiness","openApiOperationId":"createLoanBusiness","summary":"Create a business on a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Business created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113"},{"code":"400","description":"Invalid role or input"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1businesses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}}},{"code":"400"},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entities/createloanbusiness"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/businesses"},{"label":"Update a business on a loan","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/entities/updateloanbusiness","routeSlug":"/apis/public-api/entities/updateloanbusiness","metadata":{"seo":{"title":"Update a business on a loan","description":"Update the details of a business associated with a loan. Only the fields provided in the request body are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLoanBusiness","name":"Update a business on a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1businesses~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a business on a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of a business associated with a loan. Only the fields provided in the request body are changed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanId","in":"path","schemaId":"schema_72","required":true},{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1businesses~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1businesses~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_114"}},"schemaId":"schema_114","pointer":"/paths/~1public~1v1~1loans~1{loanId}~1businesses~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/loans/{loanId}/businesses/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"loanId","in":"path","required":true,"schemaId":"schema_72"},{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_114"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{loanId}/businesses/{id}","href":"entities/updateloanbusiness","openApiOperationId":"updateLoanBusiness","summary":"Update a business on a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_114","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_114"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Business updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1businesses~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entities/updateloanbusiness"}],"panels":[]}]},"httpPath":"/public/v1/loans/{loanId}/businesses/{id}"},{"label":"Create a person on a loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/entities/createloanperson","routeSlug":"/apis/public-api/entities/createloanperson","metadata":{"seo":{"title":"Create a person on a loan","description":"Create a person and attach them to the loan with the given role. Accepts a full SSN; only the last 4 digits are ever returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLoanPerson","name":"Create a person on a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1people/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a person on a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a person and attach them to the loan with the given role. Accepts a full SSN; only the last 4 digits are ever returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1people/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1people/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115","pointer":"/paths/~1public~1v1~1loans~1{id}~1people/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/{id}/people","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_115"}},"responseCodes":["201","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/people","href":"entities/createloanperson","openApiOperationId":"createLoanPerson","summary":"Create a person on a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_115","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Person created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":"Invalid role or input"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1people/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400"},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entities/createloanperson"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/people"},{"label":"Update a person on a loan","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/entities/updateloanperson","routeSlug":"/apis/public-api/entities/updateloanperson","metadata":{"seo":{"title":"Update a person on a loan","description":"Update the details of a person associated with a loan. Only the fields provided in the request body are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLoanPerson","name":"Update a person on a loan","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1people~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a person on a loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of a person associated with a loan. Only the fields provided in the request body are changed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanId","in":"path","schemaId":"schema_72","required":true},{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1people~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1people~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/~1public~1v1~1loans~1{loanId}~1people~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/loans/{loanId}/people/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"loanId","in":"path","required":true,"schemaId":"schema_72"},{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{loanId}/people/{id}","href":"entities/updateloanperson","openApiOperationId":"updateLoanPerson","summary":"Update a person on a loan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Person updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{loanId}~1people~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entities/updateloanperson"}],"panels":[]}]},"httpPath":"/public/v1/loans/{loanId}/people/{id}"}],"content":{"contentType":"group","meta":{"name":"Entities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entities","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read, create, and update the businesses and people on a loan. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /loans/{id}/entities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists them; the per-entity GETs add full addresses and contact details. Tax identifiers are masked to the last 4 digits unless the key carries "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read:businesses:ein"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read:people:ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/businesses/{id}","summary":"Get a business","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entities/getbusiness","deprecated":false},{"title":"/public/v1/people/{id}","summary":"Get a person","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entities/getperson","deprecated":false},{"title":"/public/v1/loans/{id}/businesses","summary":"Create a business on a loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entities/createloanbusiness","deprecated":false},{"title":"/public/v1/loans/{loanId}/businesses/{id}","summary":"Update a business on a loan","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entities/updateloanbusiness","deprecated":false},{"title":"/public/v1/loans/{id}/people","summary":"Create a person on a loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entities/createloanperson","deprecated":false},{"title":"/public/v1/loans/{loanId}/people/{id}","summary":"Update a person on a loan","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entities/updateloanperson","deprecated":false}]}]}]}]}},{"type":"group","label":"Documents","link":"/apis/public-api/documents","routeSlug":"/apis/public-api/documents","items":[{"label":"List loan documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/documents/listloandocuments","routeSlug":"/apis/public-api/documents/listloandocuments","metadata":{"seo":{"title":"List loan documents","description":"Retrieve every document on a loan: files uploaded against a document requirement (the rows on the loan's Documents tab, whether the requirement targets the loan, a person, or a business) plus loan-level artifacts the platform generates, such as term sheets and adverse-action notices. Each entry carries the requirement it satisfies — including its review status and its id, which is what you pass as requirementID when uploading. requirement is null for generated artifacts. Use the download endpoint to get a presigned URL for the file itself."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanDocuments","name":"List loan documents","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loan documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve every document on a loan: files uploaded against a document requirement (the rows on the loan's Documents tab, whether the requirement targets the loan, a person, or a business) plus loan-level artifacts the platform generates, such as term sheets and adverse-action notices. Each entry carries the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it satisfies — including its review "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is what you pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirementID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when uploading. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null for generated artifacts. Use the download endpoint to get a presigned URL for the file itself."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/documents","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/documents","href":"documents/listloandocuments","openApiOperationId":"listLoanDocuments","summary":"List loan documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with document list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_118","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/listloandocuments"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/documents"},{"label":"Upload a document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/documents/uploaddocument","routeSlug":"/apis/public-api/documents/uploaddocument","metadata":{"seo":{"title":"Upload a document","description":"Step 1 of 2. Creates the document record and returns a presigned upload URL; PUT the file content to that URL, then call POST /documents/{id}/confirm — the confirm step is what verifies the bytes landed and attaches the file to its requirement. A document that is never confirmed stays invisible to the bank."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadDocument","name":"Upload a document","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1 of 2. Creates the document record and returns a presigned upload URL; PUT the file content to that URL, then call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /documents/{id}/confirm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the confirm step is what verifies the bytes landed and attaches the file to its requirement. A document that is never confirmed stays invisible to the bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirementID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a requirement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /loans/{id}/documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") so the upload satisfies that requirement and appears on the banker's Documents tab for review. Omit it only for a loan-level attachment that answers no requirement — those are not surfaced for review."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this upload safely retryable. A replay with the same key returns the original response instead of creating a duplicate record."}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119","pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/loans/{id}/documents","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_119"}},"responseCodes":["201","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/documents","href":"documents/uploaddocument","openApiOperationId":"uploadDocument","summary":"Upload a document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Document record created with presigned upload URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_120","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/uploaddocument"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/documents"},{"label":"Get document download URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/documents/getdocumentdownloadurl","routeSlug":"/apis/public-api/documents/getdocumentdownloadurl","metadata":{"seo":{"title":"Get document download URL","description":"Get a presigned download URL for a document. The URL is valid for 5 minutes. Use this URL to download the actual document file directly."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentDownloadUrl","name":"Get document download URL","isWebhook":false,"pointer":"/paths/~1public~1v1~1documents~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document download URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a presigned download URL for a document. The URL is valid for 5 minutes. Use this URL to download the actual document file directly."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1documents~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/documents/{id}/download","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/documents/{id}/download","href":"documents/getdocumentdownloadurl","openApiOperationId":"getDocumentDownloadUrl","summary":"Get document download URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with download URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1documents~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_121","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getdocumentdownloadurl"}],"panels":[]}]},"httpPath":"/public/v1/documents/{id}/download"},{"label":"Confirm a document upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/documents/confirmdocumentupload","routeSlug":"/apis/public-api/documents/confirmdocumentupload","metadata":{"seo":{"title":"Confirm a document upload","description":"Step 2 of 2. Call after PUTting the file content to the presigned URL. Verifies the blob actually arrived (and is within the size cap) and, for a requirement-backed upload, attaches it to that requirement so it appears on the banker's Documents tab as PENDING review."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmDocumentUpload","name":"Confirm a document upload","isWebhook":false,"pointer":"/paths/~1public~1v1~1documents~1{id}~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm a document upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2 of 2. Call after PUTting the file content to the presigned URL. Verifies the blob actually arrived (and is within the size cap) and, for a requirement-backed upload, attaches it to that requirement so it appears on the banker's Documents tab as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" review."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Until this is called the record exists but the bank cannot see the document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the requirement collects more than one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (three years of tax returns, say) — those 400 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period_key_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise, since nothing can infer which year the file answers. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /loans/{id}/documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrying is safe in the sense that it never corrupts anything, but it is NOT a no-op: re-confirming an already-attached file adds another version to the same requirement, matching how a re-upload behaves in the UI. Retry after a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" confirm, not after a successful one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1documents~1{id}~1confirm/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1documents~1{id}~1confirm/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"schemaId":"schema_122","pointer":"/paths/~1public~1v1~1documents~1{id}~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/documents/{id}/confirm","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_122"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/documents/{id}/confirm","href":"documents/confirmdocumentupload","openApiOperationId":"confirmDocumentUpload","summary":"Confirm a document upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_122","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Upload confirmed and attached","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"400","description":"Blob missing, oversized, or the requirement cannot accept an upload"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1documents~1{id}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"400"},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/confirmdocumentupload"}],"panels":[]}]},"httpPath":"/public/v1/documents/{id}/confirm"},{"label":"Update document metadata","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/documents/updatedocument","routeSlug":"/apis/public-api/documents/updatedocument","metadata":{"seo":{"title":"Update document metadata","description":"Update document metadata. Currently only the document name can be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDocument","name":"Update document metadata","isWebhook":false,"pointer":"/paths/~1public~1v1~1documents~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update document metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update document metadata. Currently only the document name can be updated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1documents~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124"}},"schemaId":"schema_124","pointer":"/paths/~1public~1v1~1documents~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/documents/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_124"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/documents/{id}","href":"documents/updatedocument","openApiOperationId":"updateDocument","summary":"Update document metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_124","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1documents~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/updatedocument"}],"panels":[]}]},"httpPath":"/public/v1/documents/{id}"},{"label":"Delete a document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/documents/deletedocument","routeSlug":"/apis/public-api/documents/deletedocument","metadata":{"seo":{"title":"Delete a document","description":"Soft-delete a document by setting its deletion timestamp. The document will no longer appear in list results. If it satisfied a requirement it is also detached from it, and any requirement period left with no remaining file returns to AWAITING_UPLOAD."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDocument","name":"Delete a document","isWebhook":false,"pointer":"/paths/~1public~1v1~1documents~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft-delete a document by setting its deletion timestamp. The document will no longer appear in list results. If it satisfied a requirement it is also detached from it, and any requirement period left with no remaining file returns to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_UPLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1documents~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/documents/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/documents/{id}","href":"documents/deletedocument","openApiOperationId":"deleteDocument","summary":"Delete a document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1documents~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/deletedocument"}],"panels":[]}]},"httpPath":"/public/v1/documents/{id}"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":"List, upload, download, update, and delete loan documents"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/documents","summary":"List loan documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/listloandocuments","deprecated":false},{"title":"/public/v1/loans/{id}/documents","summary":"Upload a document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/uploaddocument","deprecated":false},{"title":"/public/v1/documents/{id}/download","summary":"Get document download URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getdocumentdownloadurl","deprecated":false},{"title":"/public/v1/documents/{id}/confirm","summary":"Confirm a document upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/confirmdocumentupload","deprecated":false},{"title":"/public/v1/documents/{id}","summary":"Update document metadata","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/documents/updatedocument","deprecated":false},{"title":"/public/v1/documents/{id}","summary":"Delete a document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/documents/deletedocument","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/apis/public-api/products","routeSlug":"/apis/public-api/products","items":[{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/products/listproducts","routeSlug":"/apis/public-api/products/listproducts","metadata":{"seo":{"title":"List products","description":"Retrieve a list of available loan products. Returns product details including name, description, terms, and rate types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProducts","name":"List products","isWebhook":false,"pointer":"/paths/~1public~1v1~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of available loan products. Returns product details including name, description, terms, and rate types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/products","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/public/v1/products","href":"products/listproducts","openApiOperationId":"listProducts","summary":"List products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with product list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproducts"}],"panels":[]}]},"httpPath":"/public/v1/products"},{"label":"Get product details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/products/getproduct","routeSlug":"/apis/public-api/products/getproduct","metadata":{"seo":{"title":"Get product details","description":"Retrieve detailed information about a specific loan product by ID. Returns product name, description, terms, amortization period, rate type, and payment frequency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProduct","name":"Get product details","isWebhook":false,"pointer":"/paths/~1public~1v1~1products~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve detailed information about a specific loan product by ID. Returns product name, description, terms, amortization period, rate type, and payment frequency."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1products~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/products/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/products/{id}","href":"products/getproduct","openApiOperationId":"getProduct","summary":"Get product details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with product details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1products~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproduct"}],"panels":[]}]},"httpPath":"/public/v1/products/{id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"List available loan products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproducts","deprecated":false},{"title":"/public/v1/products/{id}","summary":"Get product details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/apis/public-api/webhooks","routeSlug":"/apis/public-api/webhooks","items":[{"label":"Register a webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/createwebhookendpoint","routeSlug":"/apis/public-api/webhooks/createwebhookendpoint","metadata":{"seo":{"title":"Register a webhook endpoint","description":"Register an HTTPS endpoint to receive event deliveries. The signing secret is returned ONCE in this response and never again — store it securely. Private/loopback URLs are rejected."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhookEndpoint","name":"Register a webhook endpoint","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register an HTTPS endpoint to receive event deliveries. The signing secret is returned ONCE in this response and never again — store it securely. Private/loopback URLs are rejected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1webhook-endpoints/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128","pointer":"/paths/~1public~1v1~1webhook-endpoints/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/webhook-endpoints","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_128"}},"responseCodes":["201","400","401","403","429"],"pointer":"/public/v1/webhook-endpoints","href":"webhooks/createwebhookendpoint","openApiOperationId":"createWebhookEndpoint","summary":"Register a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_128"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Endpoint created (includes the one-time signing secret)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129"},{"code":"400","description":"Invalid URL (non-https / private host) or input"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}}},{"code":"400"},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhookendpoint"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints"},{"label":"List webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/listwebhookendpoints","routeSlug":"/apis/public-api/webhooks/listwebhookendpoints","metadata":{"seo":{"title":"List webhook endpoints","description":"List your organization's webhook endpoints. The signing secret is never returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhookEndpoints","name":"List webhook endpoints","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhook endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List your organization's webhook endpoints. The signing secret is never returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/webhook-endpoints","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/public/v1/webhook-endpoints","href":"webhooks/listwebhookendpoints","openApiOperationId":"listWebhookEndpoints","summary":"List webhook endpoints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook endpoints","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}},"schemaId":"schema_130"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_130","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhookendpoints"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints"},{"label":"Get a webhook endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/getwebhookendpoint","routeSlug":"/apis/public-api/webhooks/getwebhookendpoint","metadata":{"seo":{"title":"Get a webhook endpoint","description":"Retrieve a single webhook endpoint by ID, including its target URL, subscribed event types, and status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhookEndpoint","name":"Get a webhook endpoint","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single webhook endpoint by ID, including its target URL, subscribed event types, and status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/webhook-endpoints/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/webhook-endpoints/{id}","href":"webhooks/getwebhookendpoint","openApiOperationId":"getWebhookEndpoint","summary":"Get a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook endpoint","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhookendpoint"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints/{id}"},{"label":"Update a webhook endpoint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/updatewebhookendpoint","routeSlug":"/apis/public-api/webhooks/updatewebhookendpoint","metadata":{"seo":{"title":"Update a webhook endpoint","description":"Update a webhook endpoint — change its target URL, subscribed event types, or status. Only the fields provided in the request body are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhookEndpoint","name":"Update a webhook endpoint","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a webhook endpoint — change its target URL, subscribed event types, or status. Only the fields provided in the request body are changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132","pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/webhook-endpoints/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_132"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/webhook-endpoints/{id}","href":"webhooks/updatewebhookendpoint","openApiOperationId":"updateWebhookEndpoint","summary":"Update a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_132"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook endpoint updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131"},{"code":"400","description":"Invalid URL or input"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131"}}},{"code":"400"},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhookendpoint"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints/{id}"},{"label":"Delete a webhook endpoint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/deletewebhookendpoint","routeSlug":"/apis/public-api/webhooks/deletewebhookendpoint","metadata":{"seo":{"title":"Delete a webhook endpoint","description":"Soft-delete (disable) a webhook endpoint. Delivery history is retained."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhookEndpoint","name":"Delete a webhook endpoint","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Soft-delete (disable) a webhook endpoint. Delivery history is retained."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/webhook-endpoints/{id}","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/webhook-endpoints/{id}","href":"webhooks/deletewebhookendpoint","openApiOperationId":"deleteWebhookEndpoint","summary":"Delete a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Endpoint deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133"}},"schemaId":"schema_133"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_133","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhookendpoint"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints/{id}"},{"label":"Rotate a webhook signing secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/rotatewebhooksecret","routeSlug":"/apis/public-api/webhooks/rotatewebhooksecret","metadata":{"seo":{"title":"Rotate a webhook signing secret","description":"Generate a new signing secret. It is returned ONCE in this response and never again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rotateWebhookSecret","name":"Rotate a webhook signing secret","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1rotate-secret/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate a webhook signing secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate a new signing secret. It is returned ONCE in this response and never again."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1rotate-secret/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_93","description":"Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect."}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1rotate-secret/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/webhook-endpoints/{id}/rotate-secret","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_93"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/webhook-endpoints/{id}/rotate-secret","href":"webhooks/rotatewebhooksecret","openApiOperationId":"rotateWebhookSecret","summary":"Rotate a webhook signing secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"New signing secret (shown once)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1rotate-secret/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/rotatewebhooksecret"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints/{id}/rotate-secret"},{"label":"Send a test event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/testwebhookendpoint","routeSlug":"/apis/public-api/webhooks/testwebhookendpoint","metadata":{"seo":{"title":"Send a test event","description":"Synchronously deliver a test.ping event to the endpoint and return the result. Does not count toward auto-disable, and is intentionally NOT idempotency-keyed (safe to repeat)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testWebhookEndpoint","name":"Send a test event","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1test/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a test event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronously deliver a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test.ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event to the endpoint and return the result. Does not count toward auto-disable, and is intentionally NOT idempotency-keyed (safe to repeat)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1test/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/webhook-endpoints/{id}/test","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/webhook-endpoints/{id}/test","href":"webhooks/testwebhookendpoint","openApiOperationId":"testWebhookEndpoint","summary":"Send a test event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test delivery result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_135"}},"schemaId":"schema_135"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_135","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_135"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/testwebhookendpoint"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints/{id}/test"},{"label":"List delivery attempts for an endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/listwebhookdeliveries","routeSlug":"/apis/public-api/webhooks/listwebhookdeliveries","metadata":{"seo":{"title":"List delivery attempts for an endpoint","description":"Retrieve recent delivery attempts for a webhook endpoint, including status, response codes, and timestamps, to help debug your integration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhookDeliveries","name":"List delivery attempts for an endpoint","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1deliveries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List delivery attempts for an endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve recent delivery attempts for a webhook endpoint, including status, response codes, and timestamps, to help debug your integration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1deliveries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"},{"name":"status","in":"query","schemaId":"schema_136"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1deliveries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/webhook-endpoints/{id}/deliveries","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"},{"name":"status","in":"query","schemaId":"schema_136"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/webhook-endpoints/{id}/deliveries","href":"webhooks/listwebhookdeliveries","openApiOperationId":"listWebhookDeliveries","summary":"List delivery attempts for an endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delivery attempts (most recent first)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}},"schemaId":"schema_137"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-endpoints~1{id}~1deliveries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_137","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhookdeliveries"}],"panels":[]}]},"httpPath":"/public/v1/webhook-endpoints/{id}/deliveries"},{"label":"List supported webhook event types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/webhooks/listwebhookeventtypes","routeSlug":"/apis/public-api/webhooks/listwebhookeventtypes","metadata":{"seo":{"title":"List supported webhook event types","description":"List the webhook event types you can subscribe an endpoint to, with a short description of each."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhookEventTypes","name":"List supported webhook event types","isWebhook":false,"pointer":"/paths/~1public~1v1~1webhook-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List supported webhook event types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the webhook event types you can subscribe an endpoint to, with a short description of each."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/webhook-events","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/public/v1/webhook-events","href":"webhooks/listwebhookeventtypes","openApiOperationId":"listWebhookEventTypes","summary":"List supported webhook event types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Supported event types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1webhook-events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhookeventtypes"}],"panels":[]}]},"httpPath":"/public/v1/webhook-events"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Manage outbound webhook endpoints and inspect delivery attempts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/webhook-endpoints","summary":"Register a webhook endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhookendpoint","deprecated":false},{"title":"/public/v1/webhook-endpoints","summary":"List webhook endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhookendpoints","deprecated":false},{"title":"/public/v1/webhook-endpoints/{id}","summary":"Get a webhook endpoint","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhookendpoint","deprecated":false},{"title":"/public/v1/webhook-endpoints/{id}","summary":"Update a webhook endpoint","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/updatewebhookendpoint","deprecated":false},{"title":"/public/v1/webhook-endpoints/{id}","summary":"Delete a webhook endpoint","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhookendpoint","deprecated":false},{"title":"/public/v1/webhook-endpoints/{id}/rotate-secret","summary":"Rotate a webhook signing secret","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/rotatewebhooksecret","deprecated":false},{"title":"/public/v1/webhook-endpoints/{id}/test","summary":"Send a test event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/testwebhookendpoint","deprecated":false},{"title":"/public/v1/webhook-endpoints/{id}/deliveries","summary":"List delivery attempts for an endpoint","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhookdeliveries","deprecated":false},{"title":"/public/v1/webhook-events","summary":"List supported webhook event types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhookeventtypes","deprecated":false}]}]}]}]}},{"type":"group","label":"Messages","link":"/apis/public-api/messages","routeSlug":"/apis/public-api/messages","items":[{"label":"List loan messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/messages/listloanmessages","routeSlug":"/apis/public-api/messages/listloanmessages","metadata":{"seo":{"title":"List loan messages","description":"Retrieve messages posted on a loan across its customer/broker-visible chatrooms. Internal banker-only threads are never returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLoanMessages","name":"List loan messages","isWebhook":false,"pointer":"/paths/~1public~1v1~1loans~1{id}~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List loan messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve messages posted on a loan across its customer/broker-visible chatrooms. Internal banker-only threads are never returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_72","required":true}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1messages/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/loans/{id}/messages","servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_72"}],"query":[{"name":"limit","in":"query","schemaId":"schema_70"},{"name":"offset","in":"query","schemaId":"schema_71"},{"name":"cursor","in":"query","schemaId":"schema_72"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/public/v1/loans/{id}/messages","href":"messages/listloanmessages","openApiOperationId":"listLoanMessages","summary":"List loan messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan messages (most recent first)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_139"}},"schemaId":"schema_139"},{"code":"400","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed - Invalid or expired API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"403","description":"Insufficient permissions for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"404","description":"Requested resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"429","description":"Rate limit exceeded - Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"}],"pointer":"/paths/~1public~1v1~1loans~1{id}~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_139","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_139"}}},{"code":"400","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"403","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"404","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"429","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/listloanmessages"}],"panels":[]}]},"httpPath":"/public/v1/loans/{id}/messages"}],"content":{"contentType":"group","meta":{"name":"Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Messages","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/loans/{id}/messages","summary":"List loan messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/listloanmessages","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/PublicLoan":{"id":"components/schemas/PublicLoan","kind":"json-schema","title":"PublicLoan","data":{"type":"object","properties":{"id":{"type":"string"},"loanNumber":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string","enum":["business","personal"]},"centsAmount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"centsMonthlyPayment":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"monthsTerm":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"monthsInterestOnly":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paymentFrequency":{"nullable":true,"type":"string","enum":["weekly","biweekly","monthly","quarterly","semi-annual","annual","lump sum","irregular payments"]},"rateType":{"nullable":true,"type":"string","enum":["fixed","variable"]},"bpsRate":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"purpose":{"nullable":true,"type":"string"},"purposeNarrative":{"nullable":true,"type":"string"},"applicationDate":{"nullable":true,"type":"string"},"closeDate":{"nullable":true,"type":"string"},"maturityDate":{"nullable":true,"type":"string"},"firstPaymentDate":{"nullable":true,"type":"string"},"product":{"nullable":true,"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"stage":{"nullable":true,"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","loanNumber","status","type","centsAmount","centsMonthlyPayment","monthsTerm","monthsInterestOnly","paymentFrequency","rateType","bpsRate","purpose","purposeNarrative","applicationDate","closeDate","maturityDate","firstPaymentDate","product","stage","createdAt","updatedAt"],"additionalProperties":false}},"components/schemas/PaginationMeta":{"id":"components/schemas/PaginationMeta","kind":"json-schema","title":"PaginationMeta","data":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","enum":["offset"]},"limit":{"type":"number"},"offset":{"type":"number"},"hasMore":{"type":"boolean"}},"required":["mode","limit","offset","hasMore"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","enum":["cursor"]},"limit":{"type":"number"},"hasMore":{"type":"boolean"},"nextCursor":{"nullable":true,"type":"string"}},"required":["mode","limit","hasMore","nextCursor"],"additionalProperties":false}]}},"components/schemas/PublicProduct":{"id":"components/schemas/PublicProduct","kind":"json-schema","title":"PublicProduct","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"nullable":true,"type":"string"},"monthsTerm":{"type":"number"},"monthsAmortization":{"type":"number"},"rateType":{"type":"string","enum":["fixed","variable"]},"paymentFrequency":{"type":"string","enum":["weekly","biweekly","monthly","quarterly","semi-annual","annual","lump sum","irregular payments"]}},"required":["id","name","description","monthsTerm","monthsAmortization","rateType","paymentFrequency"],"additionalProperties":false}},"components/schemas/PublicBusiness":{"id":"components/schemas/PublicBusiness","kind":"json-schema","title":"PublicBusiness","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"dba":{"nullable":true,"type":"string"},"entityType":{"nullable":true,"type":"string"},"einLast4":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"naics":{"nullable":true,"type":"string","maxLength":6},"role":{"nullable":true,"type":"string"}},"required":["id","name","dba","entityType","einLast4","state","naics","role"],"additionalProperties":false}},"components/schemas/PublicBusinessDetail":{"id":"components/schemas/PublicBusinessDetail","kind":"json-schema","title":"PublicBusinessDetail","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"dba":{"nullable":true,"type":"string"},"entityType":{"nullable":true,"type":"string"},"einLast4":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"naics":{"nullable":true,"type":"string","maxLength":6},"role":{"nullable":true,"type":"string"},"ein":{"nullable":true,"type":"string"},"tinType":{"nullable":true,"type":"string"},"incorporationDate":{"nullable":true,"type":"string"},"phone":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"url":{"nullable":true,"type":"string"},"numberOfEmployees":{"nullable":true,"type":"number"},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address":{"type":"string"},"address2":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"zipCode":{"nullable":true,"type":"string"}},"required":["id","address","address2","city","state","zipCode"],"additionalProperties":false}}},"required":["id","name","dba","entityType","einLast4","state","naics","role","ein","tinType","incorporationDate","phone","email","url","numberOfEmployees","locations"],"additionalProperties":false}},"components/schemas/PublicPerson":{"id":"components/schemas/PublicPerson","kind":"json-schema","title":"PublicPerson","data":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"ssnLast4":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"},"ownershipPercent":{"nullable":true,"type":"number"}},"required":["id","firstName","lastName","ssnLast4","role","ownershipPercent"],"additionalProperties":false}},"components/schemas/PublicPersonDetail":{"id":"components/schemas/PublicPersonDetail","kind":"json-schema","title":"PublicPersonDetail","data":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"ssnLast4":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"},"ownershipPercent":{"nullable":true,"type":"number"},"middleName":{"nullable":true,"type":"string"},"suffix":{"nullable":true,"type":"string"},"ssn":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"phone":{"nullable":true,"type":"string"},"dob":{"nullable":true,"type":"string"},"citizenship":{"nullable":true,"type":"string"},"maritalStatus":{"nullable":true,"type":"string"},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address":{"type":"string"},"address2":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"zipCode":{"nullable":true,"type":"string"}},"required":["id","address","address2","city","state","zipCode"],"additionalProperties":false}}},"required":["id","firstName","lastName","ssnLast4","role","ownershipPercent","middleName","suffix","ssn","email","phone","dob","citizenship","maritalStatus","locations"],"additionalProperties":false}},"components/schemas/PublicDocument":{"id":"components/schemas/PublicDocument","kind":"json-schema","title":"PublicDocument","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"category":{"nullable":true,"type":"string"},"uploadedAt":{"type":"string"},"requirement":{"nullable":true,"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"nullable":true,"type":"string"},"module":{"nullable":true,"type":"string"},"entityType":{"type":"string","enum":["loan","person","business"]},"entityID":{"type":"string"},"period":{"nullable":true,"type":"string"}},"required":["id","name","status","module","entityType","entityID","period"],"additionalProperties":false}},"required":["id","name","type","size","category","uploadedAt","requirement"],"additionalProperties":false}},"components/schemas/PublicTask":{"id":"components/schemas/PublicTask","kind":"json-schema","title":"PublicTask","data":{"type":"object","properties":{"id":{"type":"string"},"loanId":{"type":"string"},"componentId":{"nullable":true,"type":"string"},"action":{"type":"string"},"triggerAction":{"nullable":true,"type":"string"},"status":{"type":"string","enum":["open","completed"]},"completedAt":{"nullable":true,"type":"string"}},"required":["id","loanId","componentId","action","triggerAction","status","completedAt"],"additionalProperties":false}},"components/schemas/PublicDecision":{"id":"components/schemas/PublicDecision","kind":"json-schema","title":"PublicDecision","data":{"type":"object","properties":{"productId":{"type":"string"},"productName":{"type":"string"},"verdict":{"type":"string","enum":["approved","declined"]},"reason":{"nullable":true,"type":"string"}},"required":["productId","productName","verdict","reason"],"additionalProperties":false}},"components/schemas/PublicLoanStatus":{"id":"components/schemas/PublicLoanStatus","kind":"json-schema","title":"PublicLoanStatus","data":{"type":"object","properties":{"status":{"nullable":true,"type":"string"},"stage":{"nullable":true,"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["status","stage"],"additionalProperties":false}},"components/schemas/PublicTimelineEvent":{"id":"components/schemas/PublicTimelineEvent","kind":"json-schema","title":"PublicTimelineEvent","data":{"type":"object","properties":{"timestamp":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"},"changedBy":{"nullable":true,"type":"string"},"note":{"nullable":true,"type":"string"}},"required":["timestamp","status","changedBy","note"],"additionalProperties":false}},"components/schemas/PublicLoanBoarding":{"id":"components/schemas/PublicLoanBoarding","kind":"json-schema","title":"PublicLoanBoarding","data":{"type":"object","properties":{"loanId":{"type":"string"},"status":{"nullable":true,"type":"string"},"releasable":{"type":"boolean"},"released":{"type":"boolean"},"releasedAt":{"nullable":true,"type":"string"},"releasedBy":{"nullable":true,"type":"string"},"boarded":{"type":"boolean"},"boardedAt":{"nullable":true,"type":"string"},"coreRecordNumber":{"nullable":true,"type":"string"}},"required":["loanId","status","releasable","released","releasedAt","releasedBy","boarded","boardedAt","coreRecordNumber"],"additionalProperties":false}},"components/schemas/PublicMessage":{"id":"components/schemas/PublicMessage","kind":"json-schema","title":"PublicMessage","data":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"authorId":{"nullable":true,"type":"string"},"authorName":{"nullable":true,"type":"string"},"parentMessageId":{"nullable":true,"type":"string"},"createdAt":{"nullable":true,"type":"string"}},"required":["id","content","authorId","authorName","parentMessageId","createdAt"],"additionalProperties":false}},"components/schemas/PublicDisbursement":{"id":"components/schemas/PublicDisbursement","kind":"json-schema","title":"PublicDisbursement","data":{"type":"object","properties":{"id":{"type":"string"},"loanId":{"type":"string"},"category":{"nullable":true,"type":"string"},"centsAmount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recipientName":{"nullable":true,"type":"string"},"recipientType":{"nullable":true,"type":"string"},"paymentMethod":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"createdAt":{"nullable":true,"type":"string"}},"required":["id","loanId","category","centsAmount","recipientName","recipientType","paymentMethod","status","notes","createdAt"],"additionalProperties":false}},"components/schemas/PublicGLAccount":{"id":"components/schemas/PublicGLAccount","kind":"json-schema","title":"PublicGLAccount","data":{"type":"object","properties":{"id":{"type":"string"},"accountNumber":{"type":"string"},"name":{"type":"string"},"mainCategory":{"type":"string"},"category":{"type":"string"},"subcategory":{"nullable":true,"type":"string"},"accountType":{"type":"string"},"isActive":{"type":"boolean"}},"required":["id","accountNumber","name","mainCategory","category","subcategory","accountType","isActive"],"additionalProperties":false}},"components/schemas/PublicCollateral":{"id":"components/schemas/PublicCollateral","kind":"json-schema","title":"PublicCollateral","data":{"type":"object","properties":{"id":{"type":"string"},"loanId":{"type":"string"},"description":{"nullable":true,"type":"string"},"category":{"nullable":true,"type":"string"},"centsMarketValue":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bpsAdvanceRate":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"centsPriorLienAmount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"centsManualPriorLien":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ownerType":{"nullable":true,"type":"string"},"ownerId":{"nullable":true,"type":"string"}},"required":["id","loanId","description","category","centsMarketValue","bpsAdvanceRate","centsPriorLienAmount","centsManualPriorLien","ownerType","ownerId"],"additionalProperties":false}},"components/schemas/PublicDebt":{"id":"components/schemas/PublicDebt","kind":"json-schema","title":"PublicDebt","data":{"type":"object","properties":{"id":{"type":"string"},"loanId":{"type":"string"},"creditorName":{"type":"string"},"debtType":{"nullable":true,"type":"string"},"centsOutstandingBalance":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"centsPaymentAmount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paymentFrequency":{"nullable":true,"type":"string"},"bpsInterestRate":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isRefinanced":{"type":"boolean"},"isSecuredByCollateral":{"type":"boolean"}},"required":["id","loanId","creditorName","debtType","centsOutstandingBalance","centsPaymentAmount","paymentFrequency","bpsInterestRate","isRefinanced","isSecuredByCollateral"],"additionalProperties":false}},"components/schemas/PublicWebhookEndpoint":{"id":"components/schemas/PublicWebhookEndpoint","kind":"json-schema","title":"PublicWebhookEndpoint","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"environment":{"type":"string"},"status":{"type":"string"},"subscribedEvents":{"type":"array","items":{"type":"string"}},"consecutiveFailures":{"type":"number"},"lastSuccessAt":{"nullable":true,"type":"string"},"lastFailureAt":{"nullable":true,"type":"string"},"lastFailureReason":{"nullable":true,"type":"string"},"autoDisabledAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","url","environment","status","subscribedEvents","consecutiveFailures","lastSuccessAt","lastFailureAt","lastFailureReason","autoDisabledAt","createdAt"],"additionalProperties":false}},"components/schemas/PublicWebhookEndpointWithSecret":{"id":"components/schemas/PublicWebhookEndpointWithSecret","kind":"json-schema","title":"PublicWebhookEndpointWithSecret","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"environment":{"type":"string"},"status":{"type":"string"},"subscribedEvents":{"type":"array","items":{"type":"string"}},"consecutiveFailures":{"type":"number"},"lastSuccessAt":{"nullable":true,"type":"string"},"lastFailureAt":{"nullable":true,"type":"string"},"lastFailureReason":{"nullable":true,"type":"string"},"autoDisabledAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"secret":{"type":"string"}},"required":["id","name","url","environment","status","subscribedEvents","consecutiveFailures","lastSuccessAt","lastFailureAt","lastFailureReason","autoDisabledAt","createdAt","secret"],"additionalProperties":false}},"components/schemas/PublicWebhookDelivery":{"id":"components/schemas/PublicWebhookDelivery","kind":"json-schema","title":"PublicWebhookDelivery","data":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"eventId":{"type":"string"},"status":{"type":"string"},"attempts":{"type":"number"},"maxAttempts":{"type":"number"},"responseStatus":{"nullable":true,"type":"number"},"responseTimeMs":{"nullable":true,"type":"number"},"nextRetryAt":{"nullable":true,"type":"string"},"deliveredAt":{"nullable":true,"type":"string"},"failedAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","event","eventId","status","attempts","maxAttempts","responseStatus","responseTimeMs","nextRetryAt","deliveredAt","failedAt","createdAt"],"additionalProperties":false}},"schema_70":{"kind":"json-schema","data":{"default":50,"type":"number","minimum":1,"maximum":100},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"number","minimum":0},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"string"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"string","enum":["draft","application","active","denied","withdrawn","funded"]},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"default":"createdAt","type":"string","enum":["createdAt","centsAmount","status","loanNumber"]},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"default":"desc","type":"string","enum":["asc","desc"]},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicLoan"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"array","items":{}},"data":{}},"required":["success","error","data"]},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"auth.invalid_key"},"message":{"type":"string","example":"Invalid or expired API key"}}},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"auth.insufficient_permissions"},"message":{"type":"string","example":"Missing required permission"}}},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"rate_limit.exceeded"},"message":{"type":"string","example":"Too many requests"},"retryAfter":{"type":"integer","example":45}}},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"default":"false","type":"string","enum":["true","false"]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/PublicLoan"},{"type":"object","properties":{"boarding":{"$ref":"#/components/schemas/PublicLoanBoarding"}}}]}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicLoan"}}},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"loan.not_found"},"message":{"type":"string","example":"Loan not found"}}},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"object","properties":{"centsAmount":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"bpsFixedRate":{"type":"integer","minimum":0,"maximum":9007199254740991},"bpsSpreadRate":{"type":"integer","minimum":0,"maximum":9007199254740991},"bpsPrimeRate":{"type":"integer","minimum":0,"maximum":9007199254740991},"rateType":{"type":"string","enum":["fixed","variable"]},"monthsTerm":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"monthsInterestOnly":{"type":"integer","minimum":0,"maximum":9007199254740991},"paymentFrequency":{"type":"string","enum":["weekly","biweekly","monthly","quarterly","semi-annual","annual","lump sum","irregular payments"]},"purpose":{"type":"string"},"purposeNarrative":{"type":"string"},"type":{"type":"string","enum":["business","personal"]},"loanNumber":{"type":"string"},"productId":{"type":"string"},"applicationDate":{"type":"string","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d))|(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?)$"},"closeDate":{"type":"string","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d))|(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?)$"},"firstPaymentDate":{"type":"string","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d))|(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?)$"}}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Loan archived"}}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"loan":{"$ref":"#/components/schemas/PublicLoan"},"metrics":{"type":"object","properties":{"centsTotalAmount":{"type":"integer"},"centsMonthlyPayment":{"type":"integer"},"monthsTerm":{"type":"integer"},"hasOpenTasks":{"type":"boolean"},"hasMessages":{"type":"boolean"}}}}}}},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"businesses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"dba":{"type":"string"},"entityType":{"type":"string"},"einLast4":{"type":"string"},"state":{"type":"string"},"role":{"type":"string"}}}},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"ssnLast4":{"type":"string"},"role":{"type":"string"},"ownershipPercent":{"type":"number"}}}}}}}},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"object","properties":{"filters":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string","enum":["draft","application","active","denied","withdrawn","funded"]}},"productIds":{"type":"array","items":{"type":"string"}},"centsAmountMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"centsAmountMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"dateRange":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"limit":{"default":50,"type":"number","minimum":1,"maximum":100},"offset":{"type":"number","minimum":0},"cursor":{"type":"string"}}},"sort":{"type":"object","properties":{"field":{"default":"createdAt","type":"string","enum":["createdAt","centsAmount","status","loanNumber"]},"order":{"default":"desc","type":"string","enum":["asc","desc"]}}}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicLoanStatus"}}},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicTimelineEvent"}}}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicLoanBoarding"}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"string","maxLength":255},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"object","properties":{"coreRecordNumber":{"type":"string","minLength":1,"maxLength":255}}},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"loan_not_released_for_boarding"},"message":{"type":"string","example":"This loan has not been released to the core yet, so it is not in the boarding queue."}}},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicTask"}}}},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicDecision"}}}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicDisbursement"}}}},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"object","properties":{"glAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated — accepted for backward compatibility and ignored."},"children":[]}]}]}],"type":"string"},"category":{"type":"string","enum":["borrower_proceeds","refinance","equipment_purchase","real_estate_purchase","payroll","broker_fee","sba_guarantee_fee","third_party_payment","other"]},"centsAmount":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount in whole cents. 50000000 = $500,000.00"},"children":[]}]}]}],"minimum":0},"recipientName":{"type":"string","minLength":1},"recipientType":{"type":"string","enum":["borrower","vendor","broker","lender","other"]},"paymentMethod":{"type":"string","enum":["wire","ach","check","internal_transfer"]},"notes":{"type":"string"}},"required":["category","centsAmount","recipientName","recipientType","paymentMethod"]},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicDisbursement"}}},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"default":0,"type":"number","minimum":0},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicGLAccount"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"object","properties":{"category":{"type":"string","enum":["borrower_proceeds","refinance","equipment_purchase","real_estate_purchase","payroll","broker_fee","sba_guarantee_fee","third_party_payment","other"]},"centsAmount":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount in whole cents. 50000000 = $500,000.00"},"children":[]}]}]}],"minimum":0},"recipientName":{"type":"string","minLength":1},"recipientType":{"type":"string","enum":["borrower","vendor","broker","lender","other"]},"paymentMethod":{"type":"string","enum":["wire","ach","check","internal_transfer"]},"status":{"type":"string","enum":["pending","approved","processing","completed","failed","cancelled"]},"notes":{"type":"string"}}},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicCollateral"}}}},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"object","properties":{"description":{"type":"string"},"category":{"type":"string"},"centsMarketValue":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Market value in whole cents. 12345600 = $123,456.00"},"children":[]}]}]}]},"bpsAdvanceRate":{"type":"integer","minimum":0,"maximum":10000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advance rate in basis points, 0–10000 (8500 = 85%). Not inferred — supply it to drive net-collateral/LTV."},"children":[]}]}]}]},"centsManualPriorLien":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Manually-entered prior lien in whole cents (used in net-collateral/LTV)."},"ownerType":{"type":"string","enum":["person","business"]},"ownerId":{"type":"string"}}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicCollateral"}}},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicDebt"}}}},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicBusinessDetail"}}},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicPersonDetail"}}},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1},"ein":{"type":"string"},"dba":{"type":"string"},"entityType":{"type":"string","enum":["C-Corp","S-Corp","General Partnership","Limited Liability Company","Limited Liability Partnership","Sole Proprietorship","Trust"]},"state":{"type":"string"},"naics":{"type":"string","maxLength":6},"role":{"type":"string","minLength":1,"description":"Entity-in-loan role name, e.g. \"borrower\" or \"guarantor\" (resolved server-side; unknown names return 400). See the roles echoed by GET /loans/:id/entities."}},"required":["name","role"]},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicBusiness"}}},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1},"ein":{"type":"string"},"dba":{"type":"string"},"entityType":{"type":"string","enum":["C-Corp","S-Corp","General Partnership","Limited Liability Company","Limited Liability Partnership","Sole Proprietorship","Trust"]},"state":{"type":"string"},"naics":{"type":"string","maxLength":6}}},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"object","properties":{"firstName":{"type":"string","minLength":1},"lastName":{"type":"string","minLength":1},"ssn":{"type":"string"},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dob":{"type":"string","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d))|(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?)$"},"role":{"type":"string","minLength":1,"description":"Entity-in-loan role name, e.g. \"borrower\" or \"guarantor\" (resolved server-side; unknown names return 400). See the roles echoed by GET /loans/:id/entities."}},"required":["firstName","lastName","role"]},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicPerson"}}},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","properties":{"firstName":{"type":"string","minLength":1},"lastName":{"type":"string","minLength":1},"ssn":{"type":"string"},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dob":{"type":"string","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d))|(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?)$"}}},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicDocument"}}}},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"type":{"type":"string","minLength":1},"size":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"requirementID":{"type":"string"}},"required":["name","type","size"]},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"uploadUrl":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"category":{"type":"string"},"uploadedAt":{"type":"string","format":"date-time"},"downloadUrl":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}}}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","properties":{"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which period this document answers, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". REQUIRED when the requirement collects more than one period (three years of tax returns, say); those 400 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period_key_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it is omitted, rather than guessing a year. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /loans/{id}/documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit only for a single-period requirement."},"children":[]}]}]}]}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicDocument"}}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255}},"required":["name"]},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Document deleted"}}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicProduct"}}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicProduct"}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"starts_with","pattern":"^https:\\/\\/.*","description":"HTTPS URL; private/loopback/metadata hosts are rejected."},"subscribedEvents":{"minItems":1,"type":"array","items":{"type":"string","enum":["loan.created","loan.status_changed","loan.funded","document.uploaded","document.signed"]}}},"required":["name","url","subscribedEvents"]},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicWebhookEndpointWithSecret"}}},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicWebhookEndpoint"}}}},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublicWebhookEndpoint"}}},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","format":"starts_with","pattern":"^https:\\/\\/.*","description":"HTTPS URL; private/loopback/metadata hosts are rejected."},"subscribedEvents":{"minItems":1,"type":"array","items":{"type":"string","enum":["loan.created","loan.status_changed","loan.funded","document.uploaded","document.signed"]}},"status":{"type":"string","enum":["active","paused","disabled"]}}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Webhook endpoint deleted"}}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"secret":{"type":"string"}}}}},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"statusCode":{"type":"integer"},"error":{"type":"string"},"responseTimeMs":{"type":"integer"},"eventId":{"type":"string"}}}}},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"string","enum":["pending","delivered","failed","retrying"]},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicWebhookDelivery"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"}}}}}},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicMessage"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}},"id":"schema_139"}},"exampleStore":{},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key obtained from Pioneer dashboard. Format: pk_live_xxx or pk_test_xxx"},"children":[]}]}]}]}},"servers":[{"url":"https://api.pioneerft.com/api"},{"url":"https://api.staging.pioneerft.com/api"}]},"options":{"schemasExpansionLevel":"all","jsonSamplesExpandLevel":"all","sortRequiredPropsFirst":true,"hidePropertiesPrefix":true,"downloadUrls":[{"title":"OpenAPI 3.1.0 description (YAML)","url":"/downloads/openapi-3.1.yaml"},{"title":"OpenAPI 3.1.0 description (JSON)","url":"/downloads/openapi-3.1.json"},{"title":"OpenAPI 3.0.3 description (YAML)","url":"/downloads/openapi.yaml"},{"title":"OpenAPI 3.0.3 description (JSON)","url":"/downloads/openapi.json"},{"title":"Postman collection","url":"/downloads/pioneer-api.postman_collection.json"},{"title":"Postman environment — Staging","url":"/downloads/pioneer-api.staging.postman_environment.json"},{"title":"Postman environment — Production","url":"/downloads/pioneer-api.production.postman_environment.json"}],"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Pioneer Loan Platform API","description":"# Pioneer Public API\n\nThe Pioneer API allows third-party systems to programmatically access loan data,\ndocuments, and related entities.\n\n## URL Structure\n\nAPI requests use environment-specific domains (following existing portal pattern):\n\n```\nProduction:  https://{api-portal}.{bank-domain}/api/public/v1/{resource}\nStaging:     https://{api-portal}.staging.{bank-domain}/api/public/v1/{resource}\n```\n\n- **Production**: `https://api.pioneerft.com/api/public/v1/...` (use `pk_live_*` keys)\n- **Staging**: `https://api.staging.pioneerft.com/api/public/v1/...` (use `pk_test_*` keys)\n\n## Versioning\n\nThe current version is **v1**, served under the `/api/public/v1` path prefix.\nThe legacy unversioned path `/api/public/...` still works but is **deprecated**:\nresponses include `Deprecation: true` and a `Sunset` header. Migrate to\n`/api/public/v1`.\n\n## Authentication\n\nAll API requests require authentication using an API key. Include your API key\nin the `Authorization` header:\n\n```\nAuthorization: Bearer pk_live_your_api_key_here\n```\n\n**Key Types:**\n- `pk_test_*` - Test keys (only work on staging URLs)\n- `pk_live_*` - Live keys (only work on production URLs - no env prefix)\n\nAPI keys can be generated in the Pioneer dashboard under Organization Settings.\nNote: Production keys require explicit approval from Pioneer.\n\n## Rate Limiting\n\nRate limits are applied per API key, with separate budgets for reads and writes:\n\n- **Reads** (GET): **100 requests per minute** per API key.\n- **Writes** (POST/PATCH/DELETE): **30 requests per minute** per API key.\n\nRate limit information is included in response headers:\n\n- `X-RateLimit-Limit`: Maximum requests per window\n- `X-RateLimit-Remaining`: Requests remaining in current window\n- `X-RateLimit-Reset`: Unix timestamp when window resets\n\nWhen rate limited, you'll receive a `429 Too Many Requests` response with\na `Retry-After` header indicating seconds to wait.\n\n**⚠️ Important:** Production API keys (`pk_live_*`) that exceed rate limits\n3 or more times within 24 hours will be automatically revoked, and your\norganization's production API access will be disabled. Contact Pioneer\nsupport to re-enable access.\n\n## Idempotency\n\nWrite requests (POST/PATCH/DELETE) accept an optional `Idempotency-Key` header\n(any opaque string up to 255 chars; a UUID is recommended). Replaying a request\nwith the same key returns the original response instead of repeating the side\neffect.\n\n## Pagination\n\nList endpoints support pagination via query parameters:\n\n- `limit`: Number of items to return (default: 50, max: 100)\n- `offset`: Number of items to skip\n\nResponse includes pagination metadata. Offset-mode responses look like:\n\n```json\n{\n  \"data\": [],\n  \"meta\": {\n    \"mode\": \"offset\",\n    \"limit\": 50,\n    \"offset\": 0,\n    \"hasMore\": true\n  }\n}\n```\n\nCursor-mode responses (returned when a `cursor` query param is supplied) instead\ncontain `{ \"mode\": \"cursor\", \"limit\": 50, \"hasMore\": true, \"nextCursor\": \"<token>\" }`,\nwhere `nextCursor` is an opaque token (null when there are no more results). Pass\nit back as the `cursor` query param to fetch the next page. Offset and cursor are\nmutually exclusive, and cursor mode always orders by creation time.\n\n## Errors\n\nErrors are returned with appropriate HTTP status codes and JSON body:\n\n```json\n{\n  \"code\": \"auth.invalid_key\",\n  \"message\": \"Invalid or expired API key\"\n}\n```\n\nCommon error codes:\n- `auth.invalid_key`: API key is invalid or expired\n- `auth.org_mismatch`: API key does not belong to the organization in the URL\n- `auth.env_mismatch`: API key type does not match URL environment\n- `auth.env_not_available`: Environment not available for this organization\n- `auth.insufficient_permissions`: API key lacks required permission\n- `auth.country_restricted`: Request IP not allowed for this API key\n- `api_key.production_not_allowed`: Organization not approved for production API keys\n- `input.invalid`: Request validation failed\n- `rate_limit.exceeded`: Too many requests\n\n## OpenAPI document\n\nThe spec is published in two OpenAPI versions, both under _Download OpenAPI\ndescription_ and each in YAML and JSON. They are generated from the same routes\nin the same run, describe the identical API, and differ only in schema dialect.\n\n**OpenAPI 3.1.0** is the current one. It uses JSON Schema 2020-12:\n`type: [..., \"null\"]` for nullables and numeric\n`exclusiveMinimum`/`exclusiveMaximum`.\n\n**OpenAPI 3.0.3** is for tooling that does not read 3.1 — the same document with\n`nullable: true` and boolean `exclusive*` instead. It is also what the Postman\ncollection is generated from. 3.0.3 is the last patch of the 3.0 line; a\nconsumer pinned to 3.0.0, 3.0.1 or 3.0.2 reads it without changes, since those\npatches clarify the specification rather than alter the document format.\n\nIf your generator supports both, take 3.1.0.\n\n## API clients\n\nReady-to-import clients are generated from these same routes in the same run, so\nthey never drift from the live API. Both are listed under _Download OpenAPI\ndescription_ above, next to the spec itself.\n\n**Postman.** Import the collection plus the environment for your target\n(Staging or Production), then set `apiKey` to your key — every request inherits\ncollection-level bearer auth. Path parameters such as `:id` appear as editable\nfields under the URL bar, and optional query parameters are pre-filled but\ndisabled, so tick only the ones you need.\n\n**Insomnia.** Imports OpenAPI directly: **Import** -> **File** -> choose the\nOpenAPI 3.0.3 YAML. Set the base environment's `base_url` to the environment you\nare targeting and add your key as a bearer token.\n\nNeed access or a key? [Contact us](https://www.pioneerft.com)."}},"baseSlug":"/apis/public-api","routesMapping":{}}