Interface DocumentDto

Export

DocumentDto

Hierarchy

  • DocumentDto

Properties

account_id created_at file_id? file_ids? id metadata? rejected_reason? request_notes? respond_by status submitted_at subtype type updated_at written_response?

Properties

account_id

account_id: string

The ID of the account owning the document.

Memberof

DocumentDto

created_at

created_at: string

Time at which the object was created.

Memberof

DocumentDto

Optional file_id

file_id?: string

The file ID of an uploaded File for the document, of type onboarding_documentation

Memberof

DocumentDto

Deprecated

Optional file_ids

file_ids?: string[]

The list of file IDs of uploaded File(s) for the document, of type onboarding_documentation

Memberof

DocumentDto

id

id: string

Unique identifier for the object.

Memberof

DocumentDto

Optional metadata

metadata?: {
    [key: string]: string;
}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

DocumentDto

Type declaration

  • [key: string]: string

Optional rejected_reason

rejected_reason?: DocumentDtoRejectedReason

The reason for rejection of the document, if applicable

Memberof

DocumentDto

Optional request_notes

request_notes?: string

Additional notes for the request of a document, offering extra context

Memberof

DocumentDto

respond_by

respond_by: string

Time at which the document request needs to be responded to.

Memberof

DocumentDto

status

status: DocumentDtoStatus

The status of the document

Memberof

DocumentDto

submitted_at

submitted_at: string

Time at which the object was submitted.

Memberof

DocumentDto

subtype

subtype: DocumentDtoSubtype

The subtype of the document

Memberof

DocumentDto

type

type: DocumentDtoType

The type of the document

Memberof

DocumentDto

updated_at

updated_at: string

Time at which the object was last updated.

Memberof

DocumentDto

Optional written_response

written_response?: string

Written response to a document that has been requested, alternative to a File

Memberof

DocumentDto

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc