Name

Perform various operations on name records.

Symitar eDocs References: Coming soon.

Operations

getNameSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

NameLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getNameSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/getNameSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3006

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

200

Successful operation.

{
  "Name": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-03-26",
    "ActiveDutyStartDate": "2026-03-26",
    "ActiveDutyVerificationDate": "2026-03-26",
    "AddrCreateDate": "2026-03-26",
    "AddrDisconnectDate": "2026-03-26",
    "AddrExpDate": "2026-03-26",
    "AddrFmLastDate": "2026-03-26",
    "AddrFmLastPurgeDate": "2026-03-26",
    "AddrRecordChangeDate": "2026-03-26",
    "AddressType": 1,
    "AltEmail": "text",
    "BeneficialOwner": 1,
    "BeneficialPercent": 1,
    "BeneficiaryPercent": 1,
    "BirthDate": "2026-03-26",
    "CarrierRoute": "text",
    "Chapter4StatusCode": "text",
    "City": "text",
    "Confidential": 1,
    "Country": "text",
    "CountryCode": "text",
    "CrAddrChgDate": "2026-03-26",
    "CrNameChgDate": "2026-03-26",
    "CrSsnChgDate": "2026-03-26",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-03-26",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-03-26",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrMonthPayChgDate": "2026-03-26",
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-03-26",
    "EcoaCode": 1,
    "EffectiveDate": "2026-03-26",
    "Email": "text",
    "EmployerName": "text",
    "ExpirationDate": "2026-03-26",
    "ExtendedName": "text",
    "ExtraAddress": "text",
    "ExtraInfo": "text",
    "First": "text",
    "FmLastPurgeDate": "2026-03-26",
    "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-03-26"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-03-26"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-03-26"
      }
    ],
    "Irs1042SAmendNum": 1,
    "IrsCorrection": 1,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrChgDate": "2026-03-26",
    "LastAddrVerifDate": "2026-03-26",
    "LastFmDate": "2026-03-26",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "Locator": 1,
    "LongName": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrActivityDate": "2026-03-26",
    "MbrAddrFileType": 1,
    "MbrAddrNumLink": "text",
    "MbrAddrNumLinkChgDate": "2026-03-26",
    "MbrAddrNumber": "text",
    "MbrCreateDate": "2026-03-26",
    "MbrDisconnectDate": "2026-03-26",
    "MbrExpDate": "2026-03-26",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-03-26",
    "MbrFmLastPurgeDate": "2026-03-26",
    "MbrRecordChangeDate": "2026-03-26",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-03-26",
    "MemberNumLink": "text",
    "MemberNumLinkChgDate": "2026-03-26",
    "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-03-26",
    "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-03-26",
    "UserDate2": "2026-03-26",
    "W8ExpirationDate": "2026-03-26",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text",
    "ZipCode": "text"
  }
}

getNamePagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/getNamePagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/getNamePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3084

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

200

Successful operation.

{
  "Name": [
    {
      "ActiveDuty": 1,
      "ActiveDutySeparationDate": "2026-03-26",
      "ActiveDutyStartDate": "2026-03-26",
      "ActiveDutyVerificationDate": "2026-03-26",
      "AddrCreateDate": "2026-03-26",
      "AddrDisconnectDate": "2026-03-26",
      "AddrExpDate": "2026-03-26",
      "AddrFmLastDate": "2026-03-26",
      "AddrFmLastPurgeDate": "2026-03-26",
      "AddrRecordChangeDate": "2026-03-26",
      "AddressType": 1,
      "AltEmail": "text",
      "BeneficialOwner": 1,
      "BeneficialPercent": 1,
      "BeneficiaryPercent": 1,
      "BirthDate": "2026-03-26",
      "CarrierRoute": "text",
      "Chapter4StatusCode": "text",
      "City": "text",
      "Confidential": 1,
      "Country": "text",
      "CountryCode": "text",
      "CrAddrChgDate": "2026-03-26",
      "CrNameChgDate": "2026-03-26",
      "CrSsnChgDate": "2026-03-26",
      "CreditReportAddrIndicator": "text",
      "CreditReportAddrIndicatorDate": "2026-03-26",
      "CreditReportConsumerInfo": "text",
      "CreditReportConsumerInfoDate": "2026-03-26",
      "CtrExempt": 1,
      "CurrGrossMonthPay": 1,
      "CurrMonthPayChgDate": "2026-03-26",
      "CurrNetMonthPay": 1,
      "DbaExtendedName": "text",
      "DbaFirst": "text",
      "DbaLast": "text",
      "DbaLongName": "text",
      "DbaMiddle": "text",
      "DbaNameFormat": 1,
      "DbaShortName": "text",
      "DbaSuffix": "text",
      "DbaTitle": "text",
      "DeathDate": "2026-03-26",
      "EcoaCode": 1,
      "EffectiveDate": "2026-03-26",
      "Email": "text",
      "EmployerName": "text",
      "ExpirationDate": "2026-03-26",
      "ExtendedName": "text",
      "ExtraAddress": "text",
      "ExtraInfo": "text",
      "First": "text",
      "FmLastPurgeDate": "2026-03-26",
      "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-03-26"
        }
      ],
      "IdentIdIssueDate": [
        {
          "EntryId": 1,
          "IdentIdIssueDate": "2026-03-26"
        }
      ],
      "IdentIdNumber": [
        {
          "EntryId": 1,
          "IdentIdNumber": "text"
        }
      ],
      "IdentIdType": [
        {
          "EntryId": 1,
          "IdentIdType": 1
        }
      ],
      "IdentIdVerifyDate": [
        {
          "EntryId": 1,
          "IdentIdVerifyDate": "2026-03-26"
        }
      ],
      "Irs1042SAmendNum": 1,
      "IrsCorrection": 1,
      "IrsCountryCode": "text",
      "Last": "text",
      "LastAddrChgDate": "2026-03-26",
      "LastAddrVerifDate": "2026-03-26",
      "LastFmDate": "2026-03-26",
      "Lei": "text",
      "License": "text",
      "Lob": "text",
      "Locator": 1,
      "LongName": "text",
      "MailOverride": 1,
      "MarketingAddress": 1,
      "MbrActivityDate": "2026-03-26",
      "MbrAddrFileType": 1,
      "MbrAddrNumLink": "text",
      "MbrAddrNumLinkChgDate": "2026-03-26",
      "MbrAddrNumber": "text",
      "MbrCreateDate": "2026-03-26",
      "MbrDisconnectDate": "2026-03-26",
      "MbrExpDate": "2026-03-26",
      "MbrFileType": 1,
      "MbrFmLastDate": "2026-03-26",
      "MbrFmLastPurgeDate": "2026-03-26",
      "MbrRecordChangeDate": "2026-03-26",
      "MbrStatus": 1,
      "MbrStatusFmDate": "2026-03-26",
      "MemberNumLink": "text",
      "MemberNumLinkChgDate": "2026-03-26",
      "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-03-26",
      "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-03-26",
      "UserDate2": "2026-03-26",
      "W8ExpirationDate": "2026-03-26",
      "WorkPhone": "text",
      "WorkPhoneExtension": "text",
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

searchNamePagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/searchNamePagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/searchNamePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3116

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

200

Successful operation.

{
  "Name": [
    {
      "ActiveDuty": 1,
      "ActiveDutySeparationDate": "2026-03-26",
      "ActiveDutyStartDate": "2026-03-26",
      "ActiveDutyVerificationDate": "2026-03-26",
      "AddrCreateDate": "2026-03-26",
      "AddrDisconnectDate": "2026-03-26",
      "AddrExpDate": "2026-03-26",
      "AddrFmLastDate": "2026-03-26",
      "AddrFmLastPurgeDate": "2026-03-26",
      "AddrRecordChangeDate": "2026-03-26",
      "AddressType": 1,
      "AltEmail": "text",
      "BeneficialOwner": 1,
      "BeneficialPercent": 1,
      "BeneficiaryPercent": 1,
      "BirthDate": "2026-03-26",
      "CarrierRoute": "text",
      "Chapter4StatusCode": "text",
      "City": "text",
      "Confidential": 1,
      "Country": "text",
      "CountryCode": "text",
      "CrAddrChgDate": "2026-03-26",
      "CrNameChgDate": "2026-03-26",
      "CrSsnChgDate": "2026-03-26",
      "CreditReportAddrIndicator": "text",
      "CreditReportAddrIndicatorDate": "2026-03-26",
      "CreditReportConsumerInfo": "text",
      "CreditReportConsumerInfoDate": "2026-03-26",
      "CtrExempt": 1,
      "CurrGrossMonthPay": 1,
      "CurrMonthPayChgDate": "2026-03-26",
      "CurrNetMonthPay": 1,
      "DbaExtendedName": "text",
      "DbaFirst": "text",
      "DbaLast": "text",
      "DbaLongName": "text",
      "DbaMiddle": "text",
      "DbaNameFormat": 1,
      "DbaShortName": "text",
      "DbaSuffix": "text",
      "DbaTitle": "text",
      "DeathDate": "2026-03-26",
      "EcoaCode": 1,
      "EffectiveDate": "2026-03-26",
      "Email": "text",
      "EmployerName": "text",
      "ExpirationDate": "2026-03-26",
      "ExtendedName": "text",
      "ExtraAddress": "text",
      "ExtraInfo": "text",
      "First": "text",
      "FmLastPurgeDate": "2026-03-26",
      "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-03-26"
        }
      ],
      "IdentIdIssueDate": [
        {
          "EntryId": 1,
          "IdentIdIssueDate": "2026-03-26"
        }
      ],
      "IdentIdNumber": [
        {
          "EntryId": 1,
          "IdentIdNumber": "text"
        }
      ],
      "IdentIdType": [
        {
          "EntryId": 1,
          "IdentIdType": 1
        }
      ],
      "IdentIdVerifyDate": [
        {
          "EntryId": 1,
          "IdentIdVerifyDate": "2026-03-26"
        }
      ],
      "Irs1042SAmendNum": 1,
      "IrsCorrection": 1,
      "IrsCountryCode": "text",
      "Last": "text",
      "LastAddrChgDate": "2026-03-26",
      "LastAddrVerifDate": "2026-03-26",
      "LastFmDate": "2026-03-26",
      "Lei": "text",
      "License": "text",
      "Lob": "text",
      "Locator": 1,
      "LongName": "text",
      "MailOverride": 1,
      "MarketingAddress": 1,
      "MbrActivityDate": "2026-03-26",
      "MbrAddrFileType": 1,
      "MbrAddrNumLink": "text",
      "MbrAddrNumLinkChgDate": "2026-03-26",
      "MbrAddrNumber": "text",
      "MbrCreateDate": "2026-03-26",
      "MbrDisconnectDate": "2026-03-26",
      "MbrExpDate": "2026-03-26",
      "MbrFileType": 1,
      "MbrFmLastDate": "2026-03-26",
      "MbrFmLastPurgeDate": "2026-03-26",
      "MbrRecordChangeDate": "2026-03-26",
      "MbrStatus": 1,
      "MbrStatusFmDate": "2026-03-26",
      "MemberNumLink": "text",
      "MemberNumLinkChgDate": "2026-03-26",
      "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-03-26",
      "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-03-26",
      "UserDate2": "2026-03-26",
      "W8ExpirationDate": "2026-03-26",
      "WorkPhone": "text",
      "WorkPhoneExtension": "text",
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

updateNameByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

NameLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/updateNameByID

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/updateNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3528

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "NameLocator": 1,
  "NameFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-03-26",
    "ActiveDutyStartDate": "2026-03-26",
    "ActiveDutyVerificationDate": "2026-03-26",
    "AddrCreateDate": "2026-03-26",
    "AddrDisconnectDate": "2026-03-26",
    "AddrExpDate": "2026-03-26",
    "AddrFmLastDate": "2026-03-26",
    "AddrFmLastPurgeDate": "2026-03-26",
    "AddrRecordChangeDate": "2026-03-26",
    "AddressType": 1,
    "AltEmail": "text",
    "BeneficialOwner": 1,
    "BeneficialPercent": 1,
    "BeneficiaryPercent": 1,
    "BirthDate": "2026-03-26",
    "CarrierRoute": "text",
    "Chapter4StatusCode": "text",
    "City": "text",
    "Confidential": 1,
    "Country": "text",
    "CountryCode": "text",
    "CrAddrChgDate": "2026-03-26",
    "CrNameChgDate": "2026-03-26",
    "CrSsnChgDate": "2026-03-26",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-03-26",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-03-26",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrMonthPayChgDate": "2026-03-26",
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-03-26",
    "EcoaCode": 1,
    "EffectiveDate": "2026-03-26",
    "Email": "text",
    "EmployerName": "text",
    "ExpirationDate": "2026-03-26",
    "ExtendedName": "text",
    "ExtraAddress": "text",
    "ExtraInfo": "text",
    "First": "text",
    "FmLastPurgeDate": "2026-03-26",
    "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-03-26"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-03-26"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-03-26"
      }
    ],
    "Irs1042SAmendNum": 1,
    "IrsCorrection": 1,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrChgDate": "2026-03-26",
    "LastAddrVerifDate": "2026-03-26",
    "LastFmDate": "2026-03-26",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "Locator": 1,
    "LongName": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrActivityDate": "2026-03-26",
    "MbrAddrFileType": 1,
    "MbrAddrNumLink": "text",
    "MbrAddrNumLinkChgDate": "2026-03-26",
    "MbrAddrNumber": "text",
    "MbrCreateDate": "2026-03-26",
    "MbrDisconnectDate": "2026-03-26",
    "MbrExpDate": "2026-03-26",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-03-26",
    "MbrFmLastPurgeDate": "2026-03-26",
    "MbrRecordChangeDate": "2026-03-26",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-03-26",
    "MemberNumLink": "text",
    "MemberNumLinkChgDate": "2026-03-26",
    "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-03-26",
    "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-03-26",
    "UserDate2": "2026-03-26",
    "W8ExpirationDate": "2026-03-26",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

createName

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

NameLocatorintegerOptional

post

/createName

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/createName HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3512

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "NameFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-03-26",
    "ActiveDutyStartDate": "2026-03-26",
    "ActiveDutyVerificationDate": "2026-03-26",
    "AddrCreateDate": "2026-03-26",
    "AddrDisconnectDate": "2026-03-26",
    "AddrExpDate": "2026-03-26",
    "AddrFmLastDate": "2026-03-26",
    "AddrFmLastPurgeDate": "2026-03-26",
    "AddrRecordChangeDate": "2026-03-26",
    "AddressType": 1,
    "AltEmail": "text",
    "BeneficialOwner": 1,
    "BeneficialPercent": 1,
    "BeneficiaryPercent": 1,
    "BirthDate": "2026-03-26",
    "CarrierRoute": "text",
    "Chapter4StatusCode": "text",
    "City": "text",
    "Confidential": 1,
    "Country": "text",
    "CountryCode": "text",
    "CrAddrChgDate": "2026-03-26",
    "CrNameChgDate": "2026-03-26",
    "CrSsnChgDate": "2026-03-26",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-03-26",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-03-26",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrMonthPayChgDate": "2026-03-26",
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-03-26",
    "EcoaCode": 1,
    "EffectiveDate": "2026-03-26",
    "Email": "text",
    "EmployerName": "text",
    "ExpirationDate": "2026-03-26",
    "ExtendedName": "text",
    "ExtraAddress": "text",
    "ExtraInfo": "text",
    "First": "text",
    "FmLastPurgeDate": "2026-03-26",
    "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-03-26"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-03-26"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-03-26"
      }
    ],
    "Irs1042SAmendNum": 1,
    "IrsCorrection": 1,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrChgDate": "2026-03-26",
    "LastAddrVerifDate": "2026-03-26",
    "LastFmDate": "2026-03-26",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "Locator": 1,
    "LongName": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrActivityDate": "2026-03-26",
    "MbrAddrFileType": 1,
    "MbrAddrNumLink": "text",
    "MbrAddrNumLinkChgDate": "2026-03-26",
    "MbrAddrNumber": "text",
    "MbrCreateDate": "2026-03-26",
    "MbrDisconnectDate": "2026-03-26",
    "MbrExpDate": "2026-03-26",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-03-26",
    "MbrFmLastPurgeDate": "2026-03-26",
    "MbrRecordChangeDate": "2026-03-26",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-03-26",
    "MemberNumLink": "text",
    "MemberNumLinkChgDate": "2026-03-26",
    "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-03-26",
    "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-03-26",
    "UserDate2": "2026-03-26",
    "W8ExpirationDate": "2026-03-26",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "NameLocator": 1
}

deleteName

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

NameLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post

/deleteName

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/deleteName HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "NameLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}