searchIrs

Perform various search operations on Internal Revenue Service (IRS) records.

Symitar eDocs References: Coming soon.

Operations

searchIrsSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/searchIrsSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllIrsFields": true,
    "IrsFields": {
      "ActualMaxContribution": true,
      "ContrLastYear": [
        1
      ],
      "ContrThisYear": [
        1
      ],
      "ContributionYear": true,
      "DistrLastYear": [
        1
      ],
      "DistrThisYear": [
        1
      ],
      "FairMarketValueDeath": true,
      "FairMarketValueLastYear": true,
      "IraRmd": true,
      "IrsCode": true,
      "IrsHolderBirthDate": true,
      "IrsHolderSpouseBirthDate": true,
      "IrsPlan": true,
      "LastDistribType": true,
      "Locator": true,
      "MaxContribution": true,
      "MsaHolderCode": true,
      "OpenDate": true,
      "RecordChangeDate": true,
      "RmdTableOption": true,
      "Ssn": true
    },
    "IrsDistributionSelectableFields": {
      "IncludeAllIrsDistributionFields": true,
      "IrsDistributionFields": {
        "Amount": true,
        "DestinationAccount": true,
        "DestinationId": true,
        "DistributionCode": true,
        "DistributionDay1": true,
        "DistributionDay2": true,
        "DistributionFreq": true,
        "DistributionMethod": true,
        "EffectiveDate": true,
        "ExpirationDate": true,
        "FedWholdAmount": true,
        "FedWholdCode": true,
        "FedWholdPercent": true,
        "LastDistributnAmt": true,
        "LastDistributnDate": true,
        "Locator": true,
        "NextDistributnDate": true,
        "RecordChangeDate": true,
        "RegE": true,
        "SourceId": [
          1
        ],
        "StateWholdAmount": true,
        "StateWholdCode": true,
        "StateWholdPercent": true,
        "Type": true
      }
    },
    "IrsNameSelectableFields": {
      "IncludeAllIrsNameFields": true,
      "IrsNameFields": {
        "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",
    "IrsChildrenFilter": {
      "IrsDistributionFilter": {
        "Query": "text"
      },
      "IrsNameFilter": {
        "Query": "text"
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "IrsList": {
    "hasReachedMaximumListSize": true,
    "Irs": [
      {
        "ActualMaxContribution": 1,
        "ContrLastYear": [
          {
            "EntryId": 1,
            "ContrLastYear": 1
          }
        ],
        "ContrThisYear": [
          {
            "EntryId": 1,
            "ContrThisYear": 1
          }
        ],
        "ContributionYear": 1,
        "DistrLastYear": [
          {
            "EntryId": 1,
            "DistrLastYear": 1
          }
        ],
        "DistrThisYear": [
          {
            "EntryId": 1,
            "DistrThisYear": 1
          }
        ],
        "FairMarketValueDeath": 1,
        "FairMarketValueLastYear": 1,
        "IraRmd": 1,
        "IrsCode": 1,
        "IrsHolderBirthDate": "2025-12-25",
        "IrsHolderSpouseBirthDate": "2025-12-25",
        "IrsPlan": 1,
        "LastDistribType": 1,
        "Locator": 1,
        "MaxContribution": 1,
        "MsaHolderCode": 1,
        "OpenDate": "2025-12-25",
        "RecordChangeDate": "2025-12-25",
        "RmdTableOption": 1,
        "Ssn": "text",
        "IrsDistributionList": {
          "hasReachedMaximumListSize": true,
          "IrsDistribution": [
            {
              "Amount": 1,
              "DestinationAccount": "text",
              "DestinationId": "text",
              "DistributionCode": 1,
              "DistributionDay1": 1,
              "DistributionDay2": 1,
              "DistributionFreq": 1,
              "DistributionMethod": 1,
              "EffectiveDate": "2025-12-25",
              "ExpirationDate": "2025-12-25",
              "FedWholdAmount": 1,
              "FedWholdCode": 1,
              "FedWholdPercent": 1,
              "LastDistributnAmt": 1,
              "LastDistributnDate": "2025-12-25",
              "Locator": 1,
              "NextDistributnDate": "2025-12-25",
              "RecordChangeDate": "2025-12-25",
              "RegE": 1,
              "SourceId": [
                {
                  "EntryId": 1,
                  "SourceId": "text"
                }
              ],
              "StateWholdAmount": 1,
              "StateWholdCode": 1,
              "StateWholdPercent": 1,
              "Type": 1
            }
          ]
        },
        "IrsNameList": {
          "hasReachedMaximumListSize": true,
          "IrsName": [
            {
              "ActiveDuty": 1,
              "ActiveDutySeparationDate": "2025-12-25",
              "ActiveDutyStartDate": "2025-12-25",
              "ActiveDutyVerificationDate": "2025-12-25",
              "AddrCreateDate": "2025-12-25",
              "AddrDisconnectDate": "2025-12-25",
              "AddrExpDate": "2025-12-25",
              "AddrFmLastDate": "2025-12-25",
              "AddrFmLastPurgeDate": "2025-12-25",
              "AddrRecordChangeDate": "2025-12-25",
              "AddressType": 1,
              "AltEmail": "text",
              "BeneficiaryPercent": 1,
              "BirthDate": "2025-12-25",
              "CarrierRoute": "text",
              "Chapter4StatusCode": "text",
              "City": "text",
              "Confidential": 1,
              "Country": "text",
              "CountryCode": "text",
              "CrAddrChgDate": "2025-12-25",
              "CrNameChgDate": "2025-12-25",
              "CrSsnChgDate": "2025-12-25",
              "CreditReportAddrIndicator": "text",
              "CreditReportAddrIndicatorDate": "2025-12-25",
              "CreditReportConsumerInfo": "text",
              "CreditReportConsumerInfoDate": "2025-12-25",
              "CtrExempt": 1,
              "CurrGrossMonthPay": 1,
              "CurrMonthPayChgDate": "2025-12-25",
              "CurrNetMonthPay": 1,
              "DbaExtendedName": "text",
              "DbaFirst": "text",
              "DbaLast": "text",
              "DbaLongName": "text",
              "DbaMiddle": "text",
              "DbaNameFormat": 1,
              "DbaShortName": "text",
              "DbaSuffix": "text",
              "DbaTitle": "text",
              "DeathDate": "2025-12-25",
              "EcoaCode": 1,
              "EffectiveDate": "2025-12-25",
              "Email": "text",
              "EmployerName": "text",
              "ExpirationDate": "2025-12-25",
              "ExtendedName": "text",
              "ExtraAddress": "text",
              "ExtraInfo": "text",
              "First": "text",
              "FmLastPurgeDate": "2025-12-25",
              "ForeignTin": "text",
              "FormW8OnFile": 1,
              "GIin": "text",
              "HomePhone": "text",
              "IdentDocFlag": [
                {
                  "EntryId": 1,
                  "IdentDocFlag": 1
                }
              ],
              "IdentIdDescription": [
                {
                  "EntryId": 1,
                  "IdentIdDescription": "text"
                }
              ],
              "IdentIdExpireDate": [
                {
                  "EntryId": 1,
                  "IdentIdExpireDate": "2025-12-25"
                }
              ],
              "IdentIdIssueDate": [
                {
                  "EntryId": 1,
                  "IdentIdIssueDate": "2025-12-25"
                }
              ],
              "IdentIdNumber": [
                {
                  "EntryId": 1,
                  "IdentIdNumber": "text"
                }
              ],
              "IdentIdType": [
                {
                  "EntryId": 1,
                  "IdentIdType": 1
                }
              ],
              "IdentIdVerifyDate": [
                {
                  "EntryId": 1,
                  "IdentIdVerifyDate": "2025-12-25"
                }
              ],
              "IrsCorrection": 1,
              "IrsCountryCode": "text",
              "Last": "text",
              "LastAddrChgDate": "2025-12-25",
              "LastAddrVerifDate": "2025-12-25",
              "LastFmDate": "2025-12-25",
              "License": "text",
              "Lob": "text",
              "Locator": 1,
              "LongName": "text",
              "MailOverride": 1,
              "MarketingAddress": 1,
              "MbrActivityDate": "2025-12-25",
              "MbrAddrFileType": 1,
              "MbrAddrNumLink": "text",
              "MbrAddrNumLinkChgDate": "2025-12-25",
              "MbrAddrNumber": "text",
              "MbrCreateDate": "2025-12-25",
              "MbrDisconnectDate": "2025-12-25",
              "MbrExpDate": "2025-12-25",
              "MbrFileType": 1,
              "MbrFmLastDate": "2025-12-25",
              "MbrFmLastPurgeDate": "2025-12-25",
              "MbrRecordChangeDate": "2025-12-25",
              "MbrStatus": 1,
              "MbrStatusFmDate": "2025-12-25",
              "MemberNumLink": "text",
              "MemberNumLinkChgDate": "2025-12-25",
              "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": "2025-12-25",
              "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": "2025-12-25",
              "UserDate2": "2025-12-25",
              "W8ExpirationDate": "2025-12-25",
              "WorkPhone": "text",
              "WorkPhoneExtension": "text",
              "ZipCode": "text",
              "BeneficialOwner": 1,
              "BeneficialPercent": 1,
              "Irs1042SAmendNum": 1,
              "Lei": "text",
              "Headquarters": 1
            }
          ]
        }
      }
    ]
  }
}

searchIrsPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchIrsPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllIrsFields": true,
    "IrsFields": {
      "ActualMaxContribution": true,
      "ContrLastYear": [
        1
      ],
      "ContrThisYear": [
        1
      ],
      "ContributionYear": true,
      "DistrLastYear": [
        1
      ],
      "DistrThisYear": [
        1
      ],
      "FairMarketValueDeath": true,
      "FairMarketValueLastYear": true,
      "IraRmd": true,
      "IrsCode": true,
      "IrsHolderBirthDate": true,
      "IrsHolderSpouseBirthDate": true,
      "IrsPlan": true,
      "LastDistribType": true,
      "Locator": true,
      "MaxContribution": true,
      "MsaHolderCode": true,
      "OpenDate": true,
      "RecordChangeDate": true,
      "RmdTableOption": true,
      "Ssn": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Irs": [
    {
      "ActualMaxContribution": 1,
      "ContrLastYear": [
        {
          "EntryId": 1,
          "ContrLastYear": 1
        }
      ],
      "ContrThisYear": [
        {
          "EntryId": 1,
          "ContrThisYear": 1
        }
      ],
      "ContributionYear": 1,
      "DistrLastYear": [
        {
          "EntryId": 1,
          "DistrLastYear": 1
        }
      ],
      "DistrThisYear": [
        {
          "EntryId": 1,
          "DistrThisYear": 1
        }
      ],
      "FairMarketValueDeath": 1,
      "FairMarketValueLastYear": 1,
      "IraRmd": 1,
      "IrsCode": 1,
      "IrsHolderBirthDate": "2025-12-25",
      "IrsHolderSpouseBirthDate": "2025-12-25",
      "IrsPlan": 1,
      "LastDistribType": 1,
      "Locator": 1,
      "MaxContribution": 1,
      "MsaHolderCode": 1,
      "OpenDate": "2025-12-25",
      "RecordChangeDate": "2025-12-25",
      "RmdTableOption": 1,
      "Ssn": "text",
      "IrsDistributionList": {
        "hasReachedMaximumListSize": true,
        "IrsDistribution": [
          {
            "Amount": 1,
            "DestinationAccount": "text",
            "DestinationId": "text",
            "DistributionCode": 1,
            "DistributionDay1": 1,
            "DistributionDay2": 1,
            "DistributionFreq": 1,
            "DistributionMethod": 1,
            "EffectiveDate": "2025-12-25",
            "ExpirationDate": "2025-12-25",
            "FedWholdAmount": 1,
            "FedWholdCode": 1,
            "FedWholdPercent": 1,
            "LastDistributnAmt": 1,
            "LastDistributnDate": "2025-12-25",
            "Locator": 1,
            "NextDistributnDate": "2025-12-25",
            "RecordChangeDate": "2025-12-25",
            "RegE": 1,
            "SourceId": [
              {
                "EntryId": 1,
                "SourceId": "text"
              }
            ],
            "StateWholdAmount": 1,
            "StateWholdCode": 1,
            "StateWholdPercent": 1,
            "Type": 1
          }
        ]
      },
      "IrsNameList": {
        "hasReachedMaximumListSize": true,
        "IrsName": [
          {
            "ActiveDuty": 1,
            "ActiveDutySeparationDate": "2025-12-25",
            "ActiveDutyStartDate": "2025-12-25",
            "ActiveDutyVerificationDate": "2025-12-25",
            "AddrCreateDate": "2025-12-25",
            "AddrDisconnectDate": "2025-12-25",
            "AddrExpDate": "2025-12-25",
            "AddrFmLastDate": "2025-12-25",
            "AddrFmLastPurgeDate": "2025-12-25",
            "AddrRecordChangeDate": "2025-12-25",
            "AddressType": 1,
            "AltEmail": "text",
            "BeneficiaryPercent": 1,
            "BirthDate": "2025-12-25",
            "CarrierRoute": "text",
            "Chapter4StatusCode": "text",
            "City": "text",
            "Confidential": 1,
            "Country": "text",
            "CountryCode": "text",
            "CrAddrChgDate": "2025-12-25",
            "CrNameChgDate": "2025-12-25",
            "CrSsnChgDate": "2025-12-25",
            "CreditReportAddrIndicator": "text",
            "CreditReportAddrIndicatorDate": "2025-12-25",
            "CreditReportConsumerInfo": "text",
            "CreditReportConsumerInfoDate": "2025-12-25",
            "CtrExempt": 1,
            "CurrGrossMonthPay": 1,
            "CurrMonthPayChgDate": "2025-12-25",
            "CurrNetMonthPay": 1,
            "DbaExtendedName": "text",
            "DbaFirst": "text",
            "DbaLast": "text",
            "DbaLongName": "text",
            "DbaMiddle": "text",
            "DbaNameFormat": 1,
            "DbaShortName": "text",
            "DbaSuffix": "text",
            "DbaTitle": "text",
            "DeathDate": "2025-12-25",
            "EcoaCode": 1,
            "EffectiveDate": "2025-12-25",
            "Email": "text",
            "EmployerName": "text",
            "ExpirationDate": "2025-12-25",
            "ExtendedName": "text",
            "ExtraAddress": "text",
            "ExtraInfo": "text",
            "First": "text",
            "FmLastPurgeDate": "2025-12-25",
            "ForeignTin": "text",
            "FormW8OnFile": 1,
            "GIin": "text",
            "HomePhone": "text",
            "IdentDocFlag": [
              {
                "EntryId": 1,
                "IdentDocFlag": 1
              }
            ],
            "IdentIdDescription": [
              {
                "EntryId": 1,
                "IdentIdDescription": "text"
              }
            ],
            "IdentIdExpireDate": [
              {
                "EntryId": 1,
                "IdentIdExpireDate": "2025-12-25"
              }
            ],
            "IdentIdIssueDate": [
              {
                "EntryId": 1,
                "IdentIdIssueDate": "2025-12-25"
              }
            ],
            "IdentIdNumber": [
              {
                "EntryId": 1,
                "IdentIdNumber": "text"
              }
            ],
            "IdentIdType": [
              {
                "EntryId": 1,
                "IdentIdType": 1
              }
            ],
            "IdentIdVerifyDate": [
              {
                "EntryId": 1,
                "IdentIdVerifyDate": "2025-12-25"
              }
            ],
            "IrsCorrection": 1,
            "IrsCountryCode": "text",
            "Last": "text",
            "LastAddrChgDate": "2025-12-25",
            "LastAddrVerifDate": "2025-12-25",
            "LastFmDate": "2025-12-25",
            "License": "text",
            "Lob": "text",
            "Locator": 1,
            "LongName": "text",
            "MailOverride": 1,
            "MarketingAddress": 1,
            "MbrActivityDate": "2025-12-25",
            "MbrAddrFileType": 1,
            "MbrAddrNumLink": "text",
            "MbrAddrNumLinkChgDate": "2025-12-25",
            "MbrAddrNumber": "text",
            "MbrCreateDate": "2025-12-25",
            "MbrDisconnectDate": "2025-12-25",
            "MbrExpDate": "2025-12-25",
            "MbrFileType": 1,
            "MbrFmLastDate": "2025-12-25",
            "MbrFmLastPurgeDate": "2025-12-25",
            "MbrRecordChangeDate": "2025-12-25",
            "MbrStatus": 1,
            "MbrStatusFmDate": "2025-12-25",
            "MemberNumLink": "text",
            "MemberNumLinkChgDate": "2025-12-25",
            "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": "2025-12-25",
            "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": "2025-12-25",
            "UserDate2": "2025-12-25",
            "W8ExpirationDate": "2025-12-25",
            "WorkPhone": "text",
            "WorkPhoneExtension": "text",
            "ZipCode": "text",
            "BeneficialOwner": 1,
            "BeneficialPercent": 1,
            "Irs1042SAmendNum": 1,
            "Lei": "text",
            "Headquarters": 1
          }
        ]
      }
    }
  ],
  "Token": "text"
}

searchIrsDistributionSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

IrsLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/searchIrsDistributionSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "IrsLocator": 1,
  "SelectableFields": {
    "IncludeAllIrsDistributionFields": true,
    "IrsDistributionFields": {
      "Amount": true,
      "DestinationAccount": true,
      "DestinationId": true,
      "DistributionCode": true,
      "DistributionDay1": true,
      "DistributionDay2": true,
      "DistributionFreq": true,
      "DistributionMethod": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "FedWholdAmount": true,
      "FedWholdCode": true,
      "FedWholdPercent": true,
      "LastDistributnAmt": true,
      "LastDistributnDate": true,
      "Locator": true,
      "NextDistributnDate": true,
      "RecordChangeDate": true,
      "RegE": true,
      "SourceId": [
        1
      ],
      "StateWholdAmount": true,
      "StateWholdCode": true,
      "StateWholdPercent": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "IrsDistributionList": {
    "hasReachedMaximumListSize": true,
    "IrsDistribution": [
      {
        "Amount": 1,
        "DestinationAccount": "text",
        "DestinationId": "text",
        "DistributionCode": 1,
        "DistributionDay1": 1,
        "DistributionDay2": 1,
        "DistributionFreq": 1,
        "DistributionMethod": 1,
        "EffectiveDate": "2025-12-25",
        "ExpirationDate": "2025-12-25",
        "FedWholdAmount": 1,
        "FedWholdCode": 1,
        "FedWholdPercent": 1,
        "LastDistributnAmt": 1,
        "LastDistributnDate": "2025-12-25",
        "Locator": 1,
        "NextDistributnDate": "2025-12-25",
        "RecordChangeDate": "2025-12-25",
        "RegE": 1,
        "SourceId": [
          {
            "EntryId": 1,
            "SourceId": "text"
          }
        ],
        "StateWholdAmount": 1,
        "StateWholdCode": 1,
        "StateWholdPercent": 1,
        "Type": 1
      }
    ]
  }
}

searchIrsDistributionPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

IrsLocatorintegerOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchIrsDistributionPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "IrsLocator": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllIrsDistributionFields": true,
    "IrsDistributionFields": {
      "Amount": true,
      "DestinationAccount": true,
      "DestinationId": true,
      "DistributionCode": true,
      "DistributionDay1": true,
      "DistributionDay2": true,
      "DistributionFreq": true,
      "DistributionMethod": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "FedWholdAmount": true,
      "FedWholdCode": true,
      "FedWholdPercent": true,
      "LastDistributnAmt": true,
      "LastDistributnDate": true,
      "Locator": true,
      "NextDistributnDate": true,
      "RecordChangeDate": true,
      "RegE": true,
      "SourceId": [
        1
      ],
      "StateWholdAmount": true,
      "StateWholdCode": true,
      "StateWholdPercent": true,
      "Type": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "IrsDistribution": [
    {
      "Amount": 1,
      "DestinationAccount": "text",
      "DestinationId": "text",
      "DistributionCode": 1,
      "DistributionDay1": 1,
      "DistributionDay2": 1,
      "DistributionFreq": 1,
      "DistributionMethod": 1,
      "EffectiveDate": "2025-12-25",
      "ExpirationDate": "2025-12-25",
      "FedWholdAmount": 1,
      "FedWholdCode": 1,
      "FedWholdPercent": 1,
      "LastDistributnAmt": 1,
      "LastDistributnDate": "2025-12-25",
      "Locator": 1,
      "NextDistributnDate": "2025-12-25",
      "RecordChangeDate": "2025-12-25",
      "RegE": 1,
      "SourceId": [
        {
          "EntryId": 1,
          "SourceId": "text"
        }
      ],
      "StateWholdAmount": 1,
      "StateWholdCode": 1,
      "StateWholdPercent": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}