POST api/SaveDocumentForm

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FORM_ID	integer	None.
strFORM_ID	string	None.
FileName	string	None.
GroupEntityName	string	None.
FORM_NAME	string	None.
FORM_TYPE_NAME	string	None.
strFORM_TYPE_NAME	string	None.
Str_FORM_SIGNATURE_DT	string	None.
Str_FORM_EXPIRY_DT	string	None.
ValidityStatus	string	None.
ValidityReason	string	None.
Str_FORM_UPLOADED_DT	string	None.
FORM_CHANGED_BY	string	None.
LINKED_OBJ_TYPE	string	None.
LINKED_OBJ_ID	integer	None.
FORM_TYPE_ID	integer	None.
FORM_UPLOADED_DT	date	None.
FILE_TYPE_NAME	string	None.
CreatedBy	integer	None.
FileGuidName	string	None.
FileBytes	Collection of byte	None.
FORM_EXPIRY_DT	date	None.
CP_ID	integer	None.
CP_NAME	string	None.
InvestorId	integer	None.
InvestorName	string	None.
GroupEntityId	integer	None.
GE_Id	integer	None.
Type	string	None.
FORM_SIGNATURE_DATE	date	None.
BO_ID	integer	None.
BO_NAME	string	None.
LINKED_INVESTOR	string	None.
LINKED_INVESTOR_INVESTOR_ID	integer	None.
STR_LINKED_INVESTOR_INVESTOR_ID	string	None.
LINKED_INVESTOR_RECORD_ID	integer	None.
STR_LINKED_INVESTOR_RECORD_ID	string	None.
LINKED_INVESTOR_INVESTOR_TYPE	string	None.
RECORD_ID	integer	None.
GE_RECORD_ID	integer	None.
strRECORD_ID	string	None.
RECORD_START_DT	date	None.
RECORD_END_DT	date	None.
strRECORD_START_DT	string	None.
strRECORD_END_DT	string	None.
FileSize	string	None.
FileType	string	None.
FilePath	string	None.
LINKED_OBJ_NAME	string	None.
DEEP_READ_TEMPLATE_ID	integer	None.
INVESTOR_TYPE	string	None.
CLIENT_ID	integer	None.
INVESTOR_ID	integer	None.
strINVESTOR_ID	string	None.
INVESTOR_RECORD_ID	integer	None.
strINVESTOR_RECORD_ID	string	None.
INVESTOR_CLIENT_REFERENCE_ID	string	None.
ENTITY_ID	integer	None.
strENTITY_ID	string	None.
ENTITY_RECORD_ID	integer	None.
strENTITY_RECORD_ID	string	None.
CONTROLLING_PERSON_ID	integer	None.
strCONTROLLING_PERSON_ID	string	None.
CP_RECORD_ID	integer	None.
strCP_RECORD_ID	string	None.
BENEFICIAL_OWNER_ID	integer	None.
strBENEFICIAL_OWNER_ID	string	None.
BO_RECORD_ID	integer	None.
strBO_RECORD_ID	string	None.
BO_CLIENT_REFERENCE_ID	string	None.
LINKED_OBJ_REFERENCE_ID	string	None.
IsSentToOcr	string	None.
EncryptedInvestorId	string	None.
EncryptedInvestorRecordID	string	None.
EncryptedBOID	string	None.
EncryptedBORecordID	string	None.
EncryptedEntityID	string	None.
EncryptedEntityRecordID	string	None.
EncryptedCPID	string	None.
EncryptedCPRecordID	string	None.
OCR_STATUS	integer	None.
Str_OCR_STATUS	string	None.
REKEY_STATUS	integer	None.
Str_REKEY_STATUS	string	None.
StrMultipleSplitFormID	string	None.
MultipleSplitFormSaveStatus	boolean	None.
MultipleSplitFormOCRStatus	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "FORM_ID": 1,
  "strFORM_ID": "sample string 1",
  "FileName": "sample string 2",
  "GroupEntityName": "sample string 3",
  "FORM_NAME": "sample string 4",
  "FORM_TYPE_NAME": "sample string 5",
  "strFORM_TYPE_NAME": "sample string 6",
  "Str_FORM_SIGNATURE_DT": "sample string 7",
  "Str_FORM_EXPIRY_DT": "sample string 8",
  "ValidityStatus": "sample string 9",
  "ValidityReason": "sample string 10",
  "Str_FORM_UPLOADED_DT": "sample string 11",
  "FORM_CHANGED_BY": "sample string 12",
  "LINKED_OBJ_TYPE": "sample string 13",
  "LINKED_OBJ_ID": 1,
  "FORM_TYPE_ID": 1,
  "FORM_UPLOADED_DT": "2025-06-23T12:07:06.0646101+00:00",
  "FILE_TYPE_NAME": "sample string 14",
  "CreatedBy": 15,
  "FileGuidName": "sample string 16",
  "FileBytes": "QEA=",
  "FORM_EXPIRY_DT": "2025-06-23T12:07:06.0646101+00:00",
  "CP_ID": 1,
  "CP_NAME": "sample string 17",
  "InvestorId": 1,
  "InvestorName": "sample string 18",
  "GroupEntityId": 1,
  "GE_Id": 1,
  "Type": "sample string 19",
  "FORM_SIGNATURE_DATE": "2025-06-23T12:07:06.0646101+00:00",
  "BO_ID": 1,
  "BO_NAME": "sample string 20",
  "LINKED_INVESTOR": "sample string 21",
  "LINKED_INVESTOR_INVESTOR_ID": 1,
  "STR_LINKED_INVESTOR_INVESTOR_ID": "sample string 22",
  "LINKED_INVESTOR_RECORD_ID": 1,
  "STR_LINKED_INVESTOR_RECORD_ID": "sample string 23",
  "LINKED_INVESTOR_INVESTOR_TYPE": "sample string 24",
  "RECORD_ID": 1,
  "GE_RECORD_ID": 1,
  "strRECORD_ID": "sample string 25",
  "RECORD_START_DT": "2025-06-23T12:07:06.0646101+00:00",
  "RECORD_END_DT": "2025-06-23T12:07:06.0646101+00:00",
  "strRECORD_START_DT": "sample string 26",
  "strRECORD_END_DT": "sample string 27",
  "FileSize": "sample string 28",
  "FileType": "sample string 29",
  "FilePath": "sample string 30",
  "LINKED_OBJ_NAME": "sample string 31",
  "DEEP_READ_TEMPLATE_ID": 1,
  "INVESTOR_TYPE": "sample string 32",
  "CLIENT_ID": 1,
  "INVESTOR_ID": 1,
  "strINVESTOR_ID": "sample string 33",
  "INVESTOR_RECORD_ID": 1,
  "strINVESTOR_RECORD_ID": "sample string 34",
  "INVESTOR_CLIENT_REFERENCE_ID": "sample string 35",
  "ENTITY_ID": 1,
  "strENTITY_ID": "sample string 36",
  "ENTITY_RECORD_ID": 1,
  "strENTITY_RECORD_ID": "sample string 37",
  "CONTROLLING_PERSON_ID": 1,
  "strCONTROLLING_PERSON_ID": "sample string 38",
  "CP_RECORD_ID": 1,
  "strCP_RECORD_ID": "sample string 39",
  "BENEFICIAL_OWNER_ID": 1,
  "strBENEFICIAL_OWNER_ID": "sample string 40",
  "BO_RECORD_ID": 1,
  "strBO_RECORD_ID": "sample string 41",
  "BO_CLIENT_REFERENCE_ID": "sample string 42",
  "LINKED_OBJ_REFERENCE_ID": "sample string 43",
  "IsSentToOcr": "sample string 44",
  "EncryptedInvestorId": "sample string 45",
  "EncryptedInvestorRecordID": "sample string 46",
  "EncryptedBOID": "sample string 47",
  "EncryptedBORecordID": "sample string 48",
  "EncryptedEntityID": "sample string 49",
  "EncryptedEntityRecordID": "sample string 50",
  "EncryptedCPID": "sample string 51",
  "EncryptedCPRecordID": "sample string 52",
  "OCR_STATUS": 1,
  "Str_OCR_STATUS": "sample string 53",
  "REKEY_STATUS": 1,
  "Str_REKEY_STATUS": "sample string 54",
  "StrMultipleSplitFormID": "sample string 55",
  "MultipleSplitFormSaveStatus": true,
  "MultipleSplitFormOCRStatus": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiPostResponseOfFormModel

Name	Type	Additional information
Data	FormModel	None.
Success	boolean	None.
Message	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "FORM_ID": 1,
    "strFORM_ID": "sample string 1",
    "FileName": "sample string 2",
    "GroupEntityName": "sample string 3",
    "FORM_NAME": "sample string 4",
    "FORM_TYPE_NAME": "sample string 5",
    "strFORM_TYPE_NAME": "sample string 6",
    "Str_FORM_SIGNATURE_DT": "sample string 7",
    "Str_FORM_EXPIRY_DT": "sample string 8",
    "ValidityStatus": "sample string 9",
    "ValidityReason": "sample string 10",
    "Str_FORM_UPLOADED_DT": "sample string 11",
    "FORM_CHANGED_BY": "sample string 12",
    "LINKED_OBJ_TYPE": "sample string 13",
    "LINKED_OBJ_ID": 1,
    "FORM_TYPE_ID": 1,
    "FORM_UPLOADED_DT": "2025-06-23T12:07:06.0646101+00:00",
    "FILE_TYPE_NAME": "sample string 14",
    "CreatedBy": 15,
    "FileGuidName": "sample string 16",
    "FileBytes": "QEA=",
    "FORM_EXPIRY_DT": "2025-06-23T12:07:06.0646101+00:00",
    "CP_ID": 1,
    "CP_NAME": "sample string 17",
    "InvestorId": 1,
    "InvestorName": "sample string 18",
    "GroupEntityId": 1,
    "GE_Id": 1,
    "Type": "sample string 19",
    "FORM_SIGNATURE_DATE": "2025-06-23T12:07:06.0646101+00:00",
    "BO_ID": 1,
    "BO_NAME": "sample string 20",
    "LINKED_INVESTOR": "sample string 21",
    "LINKED_INVESTOR_INVESTOR_ID": 1,
    "STR_LINKED_INVESTOR_INVESTOR_ID": "sample string 22",
    "LINKED_INVESTOR_RECORD_ID": 1,
    "STR_LINKED_INVESTOR_RECORD_ID": "sample string 23",
    "LINKED_INVESTOR_INVESTOR_TYPE": "sample string 24",
    "RECORD_ID": 1,
    "GE_RECORD_ID": 1,
    "strRECORD_ID": "sample string 25",
    "RECORD_START_DT": "2025-06-23T12:07:06.0646101+00:00",
    "RECORD_END_DT": "2025-06-23T12:07:06.0646101+00:00",
    "strRECORD_START_DT": "sample string 26",
    "strRECORD_END_DT": "sample string 27",
    "FileSize": "sample string 28",
    "FileType": "sample string 29",
    "FilePath": "sample string 30",
    "LINKED_OBJ_NAME": "sample string 31",
    "DEEP_READ_TEMPLATE_ID": 1,
    "INVESTOR_TYPE": "sample string 32",
    "CLIENT_ID": 1,
    "INVESTOR_ID": 1,
    "strINVESTOR_ID": "sample string 33",
    "INVESTOR_RECORD_ID": 1,
    "strINVESTOR_RECORD_ID": "sample string 34",
    "INVESTOR_CLIENT_REFERENCE_ID": "sample string 35",
    "ENTITY_ID": 1,
    "strENTITY_ID": "sample string 36",
    "ENTITY_RECORD_ID": 1,
    "strENTITY_RECORD_ID": "sample string 37",
    "CONTROLLING_PERSON_ID": 1,
    "strCONTROLLING_PERSON_ID": "sample string 38",
    "CP_RECORD_ID": 1,
    "strCP_RECORD_ID": "sample string 39",
    "BENEFICIAL_OWNER_ID": 1,
    "strBENEFICIAL_OWNER_ID": "sample string 40",
    "BO_RECORD_ID": 1,
    "strBO_RECORD_ID": "sample string 41",
    "BO_CLIENT_REFERENCE_ID": "sample string 42",
    "LINKED_OBJ_REFERENCE_ID": "sample string 43",
    "IsSentToOcr": "sample string 44",
    "EncryptedInvestorId": "sample string 45",
    "EncryptedInvestorRecordID": "sample string 46",
    "EncryptedBOID": "sample string 47",
    "EncryptedBORecordID": "sample string 48",
    "EncryptedEntityID": "sample string 49",
    "EncryptedEntityRecordID": "sample string 50",
    "EncryptedCPID": "sample string 51",
    "EncryptedCPRecordID": "sample string 52",
    "OCR_STATUS": 1,
    "Str_OCR_STATUS": "sample string 53",
    "REKEY_STATUS": 1,
    "Str_REKEY_STATUS": "sample string 54",
    "StrMultipleSplitFormID": "sample string 55",
    "MultipleSplitFormSaveStatus": true,
    "MultipleSplitFormOCRStatus": true
  },
  "Success": true,
  "Message": [
    "sample string 1",
    "sample string 2"
  ]
}