Create document upload link

Request

Security

oauth2(Required scopes: document-upload-link:create) or bearerAuth or apiKeyHeader

Path

personIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

Bodyapplication/jsonrequired

caseIdstring or null

The identifier of the case associated with the doc upload link

contactIdstring

The identifier of the contact to which the doc upload link will be sent

POST

/people/{personId}/document-upload-links

curl -i -X POST \
  'https://sandboxapi.peach.finance/api/people/{personId}/document-upload-links' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "caseId": "string",
    "contactId": "string"
  }'

Responses

Bodyapplication/json

createdAtstring, (date-time)read-only

deletedAtstring or null, (date-time)read-only

idstringread-only

updatedAtstring or null, (date-time)read-only

caseIdstring or null

The identifier of the case associated with the doc upload link

contactIdstring

The identifier of the contact to which the doc upload link will be sent

Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "caseId": "string",
  "contactId": "string"
}