For the complete documentation index, see llms.txt. This page is also available as Markdown.

updateLoan

Perform various update operations on loan records.

Symitar eDocs References: Coming soon.

Operations

updateLoanByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

application/json
post/updateLoanByID
POST /nexum/627/persistent/account/updateLoanByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "LoanId": "L001",
  "LoanFields": {
    "Description": "NEXUM W4 LOAN UPD",
    "UserChar1": "W4L"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateLoanByID"
}

updateLoanBankruptcyByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanBankruptcyIdstringOptional
Responses
200

Successful operation.

application/json
post/updateLoanBankruptcyByID
POST /nexum/627/persistent/account/updateLoanBankruptcyByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanBankruptcyId": 1,
  "LoanBankruptcyFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanBankruptcyByID"
}

updateLoanBankruptcyPrepetitionBalByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanBankruptcyIdstringOptional
LoanBankruptcyPrepetitionBalIdstringOptional
Responses
200

Successful operation.

application/json
post/updateLoanBankruptcyPrepetitionBalByID
POST /nexum/627/persistent/account/updateLoanBankruptcyPrepetitionBalByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanBankruptcyId": 1,
  "LoanBankruptcyPrepetitionBalId": 1,
  "LoanBankruptcyPrepetitionBalFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanBankruptcyPrepetitionBalByID"
}

updateLoanBillingByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanBillingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanBillingByID
POST /nexum/627/persistent/account/updateLoanBillingByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanBillingLocator": 1,
  "LoanBillingFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanBillingByID"
}

updateLoanCheckOrderByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanCheckOrderLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanCheckOrderByID
POST /nexum/627/persistent/account/updateLoanCheckOrderByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanCheckOrderLocator": 1,
  "LoanCheckOrderFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanCheckOrderByID"
}

updateLoanEscrowByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanEscrowLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanEscrowByID
POST /nexum/627/persistent/account/updateLoanEscrowByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanEscrowLocator": 1,
  "LoanEscrowFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanEscrowByID"
}

updateLoanEscrowAnalysisByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanEscrowAnalysisLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanEscrowAnalysisByID
POST /nexum/627/persistent/account/updateLoanEscrowAnalysisByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanEscrowAnalysisLocator": 1,
  "LoanEscrowAnalysisFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanEscrowAnalysisByID"
}

updateLoanHoldByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanHoldLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanHoldByID
POST /nexum/627/persistent/account/updateLoanHoldByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanHoldLocator": 1,
  "LoanHoldFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanHoldByID"
}

updateLoanLnSegmentByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanLnSegmentIdstringOptional
Responses
200

Successful operation.

application/json
post/updateLoanLnSegmentByID
POST /nexum/627/persistent/account/updateLoanLnSegmentByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanLnSegmentId": 1,
  "LoanLnSegmentFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanLnSegmentByID"
}

updateLoanLnSegmentBillingByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanLnSegmentIdstringOptional
LoanLnSegmentBillingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanLnSegmentBillingByID
POST /nexum/627/persistent/account/updateLoanLnSegmentBillingByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanLnSegmentId": 1,
  "LoanLnSegmentBillingLocator": 1,
  "LoanLnSegmentBillingFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanLnSegmentBillingByID"
}

updateLoanNoteByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanNoteLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanNoteByID
POST /nexum/627/persistent/account/updateLoanNoteByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanNoteLocator": 1,
  "LoanNoteFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanNoteByID"
}

updateLoanRateChangeByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanRateChangeLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanRateChangeByID
POST /nexum/627/persistent/account/updateLoanRateChangeByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanRateChangeLocator": 1,
  "LoanRateChangeFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanRateChangeByID"
}

updateLoanScheduleByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanScheduleIdstringOptional
Responses
200

Successful operation.

application/json
post/updateLoanScheduleByID
POST /nexum/627/persistent/account/updateLoanScheduleByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanScheduleId": 1,
  "LoanScheduleFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanScheduleByID"
}

updateLoanTrackingByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanTrackingByID
POST /nexum/627/persistent/account/updateLoanTrackingByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanTrackingLocator": 1,
  "LoanTrackingFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanTrackingByID"
}

updateLoanTransferByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanTransferLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanTransferByID
POST /nexum/627/persistent/account/updateLoanTransferByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanTransferLocator": 1,
  "LoanTransferFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanTransferByID"
}

updateLoanNameByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanNameLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanNameByID
POST /nexum/627/persistent/account/updateLoanNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 3733

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "LoanId": "text",
  "LoanNameLocator": 1,
  "LoanNameFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-01-01",
    "ActiveDutyStartDate": "2026-01-01",
    "ActiveDutyVerificationDate": "2026-01-01",
    "AddrCreateDate": "2026-01-01",
    "AddrDisconnectDate": "2026-01-01",
    "AddrExpDate": "2026-01-01",
    "AddrFmLastDate": "2026-01-01",
    "AddrFmLastPurgeDate": "2026-01-01",
    "AddrRecordChangeDate": "2026-01-01",
    "AddressType": 1,
    "AltEmail": "text",
    "BeneficialOwner": 1,
    "BeneficialPercent": 1,
    "BeneficiaryPercent": 1,
    "BirthDate": "2026-01-01",
    "CarrierRoute": "text",
    "Chapter4StatusCode": "text",
    "City": "text",
    "Confidential": 1,
    "Country": "text",
    "CountryCode": "text",
    "CrAddrChgDate": "2026-01-01",
    "CrNameChgDate": "2026-01-01",
    "CrSsnChgDate": "2026-01-01",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-01-01",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-01-01",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrMonthPayChgDate": "2026-01-01",
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-01-01",
    "EcoaCode": 1,
    "EffectiveDate": "2026-01-01",
    "Email": "text",
    "EmployerName": "text",
    "ExpirationDate": "2026-01-01",
    "ExtendedName": "text",
    "ExtraAddress": "text",
    "ExtraInfo": "text",
    "First": "text",
    "FmLastPurgeDate": "2026-01-01",
    "ForeignTin": "text",
    "FormW8OnFile": 1,
    "GIin": "text",
    "Headquarters": 1,
    "HomePhone": "text",
    "IdentDocFlag": [
      {
        "EntryId": 1,
        "IdentDocFlag": 1
      }
    ],
    "IdentIdDescription": [
      {
        "EntryId": 1,
        "IdentIdDescription": "text"
      }
    ],
    "IdentIdExpireDate": [
      {
        "EntryId": 1,
        "IdentIdExpireDate": "2026-01-01"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-01-01"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-01-01"
      }
    ],
    "Irs1042SAmendNum": 1,
    "IrsCorrection": 1,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrChgDate": "2026-01-01",
    "LastAddrVerifDate": "2026-01-01",
    "LastFmDate": "2026-01-01",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "Locator": 1,
    "LongName": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrActivityDate": "2026-01-01",
    "MbrAddrFileType": 1,
    "MbrAddrNumLink": "text",
    "MbrAddrNumLinkChgDate": "2026-01-01",
    "MbrAddrNumber": "text",
    "MbrCreateDate": "2026-01-01",
    "MbrDisconnectDate": "2026-01-01",
    "MbrExpDate": "2026-01-01",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-01-01",
    "MbrFmLastPurgeDate": "2026-01-01",
    "MbrRecordChangeDate": "2026-01-01",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-01-01",
    "MemberNumLink": "text",
    "MemberNumLinkChgDate": "2026-01-01",
    "MemberNumber": "text",
    "Middle": "text",
    "MobilePhone": "text",
    "MothersMaidenName": "text",
    "NameFormat": 1,
    "NonAcctNameNum": "text",
    "NraExemptionCode": "text",
    "NraTaxRate": 1,
    "Occupation": "text",
    "PagerNumber": "text",
    "PhoneType": 1,
    "PreferredContact": "text",
    "PreferredContactMethod": 1,
    "RecordChangeDate": "2026-01-01",
    "Restrict": 1,
    "Sex": "text",
    "ShortName": "text",
    "Ssn": "text",
    "SsnCertification": 1,
    "SsnOverride": 1,
    "SsnType": 1,
    "State": "text",
    "Street": "text",
    "SubType": 1,
    "SubstantialOwner": 1,
    "Suffix": "text",
    "Title": "text",
    "Type": 1,
    "UsPersonFlag": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2026-01-01",
    "UserDate2": "2026-01-01",
    "W8ExpirationDate": "2026-01-01",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

updateLoanPledgeByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanPledgeLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanPledgeByID
POST /nexum/627/persistent/account/updateLoanPledgeByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 661

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "LoanId": "text",
  "LoanPledgeLocator": 1,
  "LoanPledgeFields": {
    "AccountNumber": "text",
    "Amount": 1,
    "CollateralCode": 1,
    "CollateralDescription": "text",
    "CollateralNumber": "text",
    "EffectiveDate": "2026-01-01",
    "ExpirationDate": "2026-01-01",
    "Id": "text",
    "Locator": 1,
    "Percent": 1,
    "Priority": 1,
    "RecordChangeDate": "2026-01-01",
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

updateLoanPledgeNameByID

post
Authorizations
Body
AccountNumberstringOptional
LoanIdstringOptional
LoanPledgeLocatorintegerOptional
LoanPledgeNameLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateLoanPledgeNameByID
POST /nexum/627/persistent/account/updateLoanPledgeNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 3767

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "LoanId": "text",
  "LoanPledgeLocator": 1,
  "LoanPledgeNameLocator": 1,
  "LoanPledgeNameFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-01-01",
    "ActiveDutyStartDate": "2026-01-01",
    "ActiveDutyVerificationDate": "2026-01-01",
    "AddrCreateDate": "2026-01-01",
    "AddrDisconnectDate": "2026-01-01",
    "AddrExpDate": "2026-01-01",
    "AddrFmLastDate": "2026-01-01",
    "AddrFmLastPurgeDate": "2026-01-01",
    "AddrRecordChangeDate": "2026-01-01",
    "AddressType": 1,
    "AltEmail": "text",
    "BeneficialOwner": 1,
    "BeneficialPercent": 1,
    "BeneficiaryPercent": 1,
    "BirthDate": "2026-01-01",
    "CarrierRoute": "text",
    "Chapter4StatusCode": "text",
    "City": "text",
    "Confidential": 1,
    "Country": "text",
    "CountryCode": "text",
    "CrAddrChgDate": "2026-01-01",
    "CrNameChgDate": "2026-01-01",
    "CrSsnChgDate": "2026-01-01",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-01-01",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-01-01",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrMonthPayChgDate": "2026-01-01",
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-01-01",
    "EcoaCode": 1,
    "EffectiveDate": "2026-01-01",
    "Email": "text",
    "EmployerName": "text",
    "ExpirationDate": "2026-01-01",
    "ExtendedName": "text",
    "ExtraAddress": "text",
    "ExtraInfo": "text",
    "First": "text",
    "FmLastPurgeDate": "2026-01-01",
    "ForeignTin": "text",
    "FormW8OnFile": 1,
    "GIin": "text",
    "Headquarters": 1,
    "HomePhone": "text",
    "IdentDocFlag": [
      {
        "EntryId": 1,
        "IdentDocFlag": 1
      }
    ],
    "IdentIdDescription": [
      {
        "EntryId": 1,
        "IdentIdDescription": "text"
      }
    ],
    "IdentIdExpireDate": [
      {
        "EntryId": 1,
        "IdentIdExpireDate": "2026-01-01"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-01-01"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-01-01"
      }
    ],
    "Irs1042SAmendNum": 1,
    "IrsCorrection": 1,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrChgDate": "2026-01-01",
    "LastAddrVerifDate": "2026-01-01",
    "LastFmDate": "2026-01-01",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "Locator": 1,
    "LongName": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrActivityDate": "2026-01-01",
    "MbrAddrFileType": 1,
    "MbrAddrNumLink": "text",
    "MbrAddrNumLinkChgDate": "2026-01-01",
    "MbrAddrNumber": "text",
    "MbrCreateDate": "2026-01-01",
    "MbrDisconnectDate": "2026-01-01",
    "MbrExpDate": "2026-01-01",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-01-01",
    "MbrFmLastPurgeDate": "2026-01-01",
    "MbrRecordChangeDate": "2026-01-01",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-01-01",
    "MemberNumLink": "text",
    "MemberNumLinkChgDate": "2026-01-01",
    "MemberNumber": "text",
    "Middle": "text",
    "MobilePhone": "text",
    "MothersMaidenName": "text",
    "NameFormat": 1,
    "NonAcctNameNum": "text",
    "NraExemptionCode": "text",
    "NraTaxRate": 1,
    "Occupation": "text",
    "PagerNumber": "text",
    "PhoneType": 1,
    "PreferredContact": "text",
    "PreferredContactMethod": 1,
    "RecordChangeDate": "2026-01-01",
    "Restrict": 1,
    "Sex": "text",
    "ShortName": "text",
    "Ssn": "text",
    "SsnCertification": 1,
    "SsnOverride": 1,
    "SsnType": 1,
    "State": "text",
    "Street": "text",
    "SubType": 1,
    "SubstantialOwner": 1,
    "Suffix": "text",
    "Title": "text",
    "Type": 1,
    "UsPersonFlag": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2026-01-01",
    "UserDate2": "2026-01-01",
    "W8ExpirationDate": "2026-01-01",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

Last updated

Was this helpful?