Upload a document

Request

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.

Pass requirementID (a requirement id from GET /loans/{id}/documents) 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.

Security

ApiKeyAuth

Path

idstringrequired

Idempotency-Keystring, <= 255 characters

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.

Bodyapplication/jsonrequired

namestring, [ 1 .. 255 ] charactersrequired

typestring, non-emptyrequired

sizeinteger, ( 0 .. 9007199254740991 ]required

requirementIDstring

curl -i -X POST \
  'https://api.pioneerft.com/api/public/v1/loans/{id}/documents' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "name": "string",
    "type": "string",
    "size": 1,
    "requirementID": "string"
  }'

Responses

Document record created with presigned upload URL

Bodyapplication/json

dataobject

Response

{
  "data": {
    "id": "string",
    "uploadUrl": "http://example.com",
    "expiresAt": "2019-08-24T14:15:22Z"
  }
}