Get Started

Sections

Theme switcher

Update Document

Header Parameters

Api-Keystring

Path Parameters

idinteger Required

Id of Contact

doc_idinteger Required

Id of Document to retrieve

file_typestring Required

File Type

Enum values:
esignedclixsigngenerateduploaded

Body Parameters

file_namestring

Include the File Type extension in the name of the file. (e.g. .txt, .pdf, etc.)

fnamestring
doc_typestring

This property is an integer value, that is passed as a string. The value set must be one of the pre-existing doc_types available to the Contact. The "Get All Document Types" API Endpoint can be used to retrieve a list of the existing doc_type.

created_byobject

User Record

Show child attributes

descriptionstring
file_contentstring

HMAC-signed AWS S3 download link

Response

200
Object
Successfully retrieved document

Response Attributes

responseobject

Contact File Object

Show child attributes

statusobject

Show child attributes

400
Object
An error has occurred

Response Attributes

statusobject

Error Response Status

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PUT

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?