- Start
- API-Referenz
- API-Dokumentation (XML/ JSON)
- Objekte
Objekt Contact Document
Beschreibung
Das Objekt ContactDocument bildet die Liste aller Dokumente ab, die einem Kontakt zugeordnet sind.
Aufbau
| JSON Keyword | XML Keyword | Häufigkeit | Typ | Format | Beschreibung |
|---|---|---|---|---|---|
| id | 1 | integer | int64 | Eindeutige ID für das Dokument. | |
| document | document | 1 | object | Document | Objekt mit dem dazugehörigen Dateiinhalt. |
| contact | contact | 1 | object | Dem Dokument zugeordneter Kontakt | |
type | type | 1 | enum | ContactDocumentType Enum | Typ des Dokuments. Pro Kontakt kann einem Dokumenttyp nur ein Dokument zugeordnet sein. |
| verification | verification | 1 | enum | GenericStatus Enum | Der aktuelle Verifizierungsstatus des Dokuments. |
| created | created | 1 | string | date-time | Datum, an dem das Dokument angelegt wurde. |
| updated | updated | 1 | string | date-time | Datum, an dem das Dokument zuletzt aktualisiert wurde. |
| expire | expire | 1 | string | date-time | Datum, an dem das Dokument abläuft und gelöscht wird. Dies ist in der Regel nach 2 Jahren. |
| - | content_name | 1 | string | Name des Dokuments. | |
| - | content_type | 1 | string | Der MIME-Type des Dokuments. | |
| - | content | 1 | byte | Base64 | Der Inhalt als base64-codierter String. |
| - | override | 0 - 1 | boolean | Gibt an ob ein vorhandenes Dokument überschrieben werden soll. Ein Dokument gilt als gleich, wenn Kontakt-ID und Dokument-Typ identisch sind. 1 = Wird überschrieben 2 = Wird nicht überschrieben. |