Get document upload links

Request

Security

oauth2(Required scopes: document-upload-link:list) 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.

GET

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

curl -i -X GET \
  'https://sandboxapi.peach.finance/api/people/{personId}/document-upload-links' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

Array [

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"
  }
]