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
LoanIdstringOptional
AccountNumberstringOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

updateLoanBankruptcyByID

post
Authorizations
Body
LoanBankruptcyIdstringOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanBankruptcyId": 1,
  "LoanBankruptcyUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "LoanBankruptcyPrepetitionBalUpdateRequest": [],
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanBankruptcyPrepetitionBalByID

post
Authorizations
Body
LoanBankruptcyPrepetitionBalIdstringOptional
AccountNumberstringOptional
LoanIdstringOptional
LoanBankruptcyIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanBankruptcyPrepetitionBalId": 1,
  "LoanBankruptcyPrepetitionBalUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanBankruptcyId": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanBillingByID

post
Authorizations
Body
LoanBillingLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanBillingLocator": 1,
  "LoanBillingUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanCheckOrderByID

post
Authorizations
Body
LoanCheckOrderLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanCheckOrderLocator": 1,
  "LoanCheckOrderUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanEscrowByID

post
Authorizations
Body
LoanEscrowLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanEscrowLocator": 1,
  "LoanEscrowUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanEscrowAnalysisByID

post
Authorizations
Body
LoanEscrowAnalysisLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanEscrowAnalysisLocator": 1,
  "LoanEscrowAnalysisUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanHoldByID

post
Authorizations
Body
LoanHoldLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanHoldLocator": 1,
  "LoanHoldUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanLnSegmentByID

post
Authorizations
Body
LoanLnSegmentIdstringOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanLnSegmentId": 1,
  "LoanLnSegmentUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "LoanLnSegmentBillingUpdateRequest": [],
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanLnSegmentBillingByID

post
Authorizations
Body
LoanLnSegmentBillingLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
LoanLnSegmentIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanLnSegmentBillingLocator": 1,
  "LoanLnSegmentBillingUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "LoanLnSegmentId": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanNoteByID

post
Authorizations
Body
LoanNoteLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanNoteLocator": 1,
  "LoanNoteUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanRateChangeByID

post
Authorizations
Body
LoanRateChangeLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanRateChangeLocator": 1,
  "LoanRateChangeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanScheduleByID

post
Authorizations
Body
LoanScheduleIdstringOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanScheduleId": 1,
  "LoanScheduleUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanTrackingByID

post
Authorizations
Body
LoanTrackingLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanTrackingLocator": 1,
  "LoanTrackingUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanTransferByID

post
Authorizations
Body
LoanTransferLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LoanTransferLocator": 1,
  "LoanTransferUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "LoanId": "20",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

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

updateLoanNameByID

post
Authorizations
Body
LoanNameLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "LoanNameLocator": 1,
  "LoanNameUpdatableFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-01-01",
    "ActiveDutyStartDate": "2026-01-01",
    "ActiveDutyVerificationDate": "2026-01-01",
    "AddrExpDate": "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",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-01-01",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-01-01",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "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",
    "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",
    "LastAddrVerifDate": "2026-01-01",
    "Lei": "text",
    "Lob": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrAddrNumLink": "text",
    "MbrExpDate": "2026-01-01",
    "MbrStatus": 1,
    "MemberNumLink": "text",
    "Middle": "text",
    "MobilePhone": "text",
    "MothersMaidenName": "text",
    "NameFormat": 1,
    "NonAcctNameNum": "text",
    "NraExemptionCode": "text",
    "NraTaxRate": 1,
    "Occupation": "text",
    "PagerNumber": "text",
    "PhoneType": 1,
    "PreferredContactMethod": 1,
    "Restrict": 1,
    "Sex": "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"
  },
  "AccountNumber": "text",
  "LoanId": "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
LoanPledgeLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "LoanPledgeLocator": 1,
  "LoanPledgeUpdatableFields": {
    "AccountNumber": "text",
    "Amount": 1,
    "CollateralCode": 1,
    "CollateralNumber": "text",
    "EffectiveDate": "2026-01-01",
    "ExpirationDate": "2026-01-01",
    "Id": "text",
    "Percent": 1,
    "Priority": 1,
    "Type": 1
  },
  "LoanPledgeNameUpdateRequest": [
    {
      "LoanPledgeNameLocator": 1,
      "LoanPledgeNameUpdatableFields": {
        "ActiveDuty": 1,
        "ActiveDutySeparationDate": "2026-01-01",
        "ActiveDutyStartDate": "2026-01-01",
        "ActiveDutyVerificationDate": "2026-01-01",
        "AddrExpDate": "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",
        "CreditReportAddrIndicator": "text",
        "CreditReportAddrIndicatorDate": "2026-01-01",
        "CreditReportConsumerInfo": "text",
        "CreditReportConsumerInfoDate": "2026-01-01",
        "CtrExempt": 1,
        "CurrGrossMonthPay": 1,
        "CurrNetMonthPay": 1,
        "DbaExtendedName": "text",
        "DbaFirst": "text",
        "DbaLast": "text",
        "DbaMiddle": "text",
        "DbaNameFormat": 1,
        "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",
        "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,
        "IrsCountryCode": "text",
        "Last": "text",
        "LastAddrVerifDate": "2026-01-01",
        "Lei": "text",
        "Lob": "text",
        "MarketingAddress": 1,
        "MbrAddrNumLink": "text",
        "MbrExpDate": "2026-01-01",
        "MbrStatus": 1,
        "MemberNumLink": "text",
        "Middle": "text",
        "MobilePhone": "text",
        "MothersMaidenName": "text",
        "NameFormat": 1,
        "NonAcctNameNum": "text",
        "NraExemptionCode": "text",
        "NraTaxRate": 1,
        "Occupation": "text",
        "PagerNumber": "text",
        "PhoneType": 1,
        "PreferredContactMethod": 1,
        "Restrict": 1,
        "Sex": "text",
        "Ssn": "text",
        "SsnCertification": 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"
      }
    }
  ],
  "AccountNumber": "text",
  "LoanId": "text",
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

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

updateLoanPledgeNameByID

post
Authorizations
Body
LoanPledgeNameLocatorintegerOptional
AccountNumberstringOptional
LoanIdstringOptional
LoanPledgeLocatorintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "LoanPledgeNameLocator": 1,
  "LoanPledgeNameUpdatableFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-01-01",
    "ActiveDutyStartDate": "2026-01-01",
    "ActiveDutyVerificationDate": "2026-01-01",
    "AddrExpDate": "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",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-01-01",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-01-01",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "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",
    "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,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrVerifDate": "2026-01-01",
    "Lei": "text",
    "Lob": "text",
    "MarketingAddress": 1,
    "MbrAddrNumLink": "text",
    "MbrExpDate": "2026-01-01",
    "MbrStatus": 1,
    "MemberNumLink": "text",
    "Middle": "text",
    "MobilePhone": "text",
    "MothersMaidenName": "text",
    "NameFormat": 1,
    "NonAcctNameNum": "text",
    "NraExemptionCode": "text",
    "NraTaxRate": 1,
    "Occupation": "text",
    "PagerNumber": "text",
    "PhoneType": 1,
    "PreferredContactMethod": 1,
    "Restrict": 1,
    "Sex": "text",
    "Ssn": "text",
    "SsnCertification": 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"
  },
  "AccountNumber": "text",
  "LoanId": "text",
  "LoanPledgeLocator": 1,
  "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?