Table of Contents

Description

The ContactDocument object represents the list of all documents associated with a contact.

Structure

Keyword JSONKeyword XMLOccursTypeFormatDescription

id1integerint64Unique ID for the document.
documentdocument1objectDocumentObject with the respective file content.
contactcontact1object

Contact

Contact associated with the document.

type

type1enumContactDocumentType EnumType of the document. Only one document can be assigned to a document type per contact.
verificationverification1enumGenericStatus EnumThe current verification status of the document.
createdcreated1stringdate-timeDate when the document was created.
updatedupdated1stringdate-timeDate when the document was last updated.
expireexpire1stringdate-timeDate when the document expires and is deleted. This is usually after 2 years.
-content_name1string
Document name
-content_type1string
The MIME type of the document.
-content1byteBase64The content as a base64 encoded string.
-override0 - 1boolean

Specifies whether an existing document should be overwritten. A document is considered to be the same if the contact ID and document type are identical.

  • 1 = Will be overwritten
  • 2 = Will not be overwritten