Interface OrdersApiModelRegulatedInformationField

A field collected from the regulatory form.

RegulatedInformationField

interface OrdersApiModelRegulatedInformationField {
    FieldId: string;
    FieldLabel: string;
    FieldType:
        | OrdersApiModelRegulatedInformationFieldFieldTypeEnum
        | "Text"
        | "FileAttachment";
    FieldValue: string;
}

Properties

FieldId: string

The unique identifier of the field.

RegulatedInformationField

FieldLabel: string

The name of the field.

RegulatedInformationField

FieldType:
    | OrdersApiModelRegulatedInformationFieldFieldTypeEnum
    | "Text"
    | "FileAttachment"

The type of field.

RegulatedInformationField

FieldValue: string

The content of the field as collected in regulatory form. Note that FileAttachment type fields contain a URL where you can download the attachment.

RegulatedInformationField