Skip to content
NexumAPI Docs

Irs⁠

Browse the Irs operations available through the SymXchange AccountService.

Operations⁠

createIrs⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
IrsLocatorintegeroptional
POST/nexum/{sym}/2022.01/account/createIrs
POST /nexum/627/2022.01/account/createIrs HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsCreatableFields": {
    "IrsCode": 0,
    "IrsPlan": 0,
    "ContributionYear": 0,
    "OpenDate": "2026-01-01",
    "Ssn": "0",
    "IrsHolderBirthDate": "2026-01-01"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createIrsDistribution⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
IrsDistributionLocatorintegeroptional
POST/nexum/{sym}/2022.01/account/createIrsDistribution
POST /nexum/627/2022.01/account/createIrsDistribution HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "IrsDistributionCreatableFields": {
    "Type": 0,
    "DistributionCode": 0,
    "DistributionMethod": 0,
    "DistributionFreq": 0,
    "DistributionDay1": 0,
    "EffectiveDate": "2026-01-01",
    "Amount": 0,
    "SourceId": [
      {
        "EntryId": 0,
        "SourceId": "0"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createIrsName⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
IrsNameLocatorintegeroptional
POST/nexum/{sym}/2022.01/account/createIrsName
POST /nexum/627/2022.01/account/createIrsName HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "IrsNameCreatableFields": {
    "ActiveDuty": 0,
    "ActiveDutySeparationDate": "string",
    "ActiveDutyStartDate": "string",
    "ActiveDutyVerificationDate": "string",
    "AddrExpDate": "string",
    "AddressType": 0,
    "AltEmail": "string",
    "BeneficialOwner": 0,
    "BeneficialPercent": 0,
    "BeneficiaryPercent": 0,
    "BirthDate": "string",
    "CarrierRoute": "string",
    "Chapter4StatusCode": "string",
    "City": "string",
    "Confidential": 0,
    "Country": "string",
    "CountryCode": "string",
    "CreditReportAddrIndicator": "string",
    "CreditReportAddrIndicatorDate": "string",
    "CreditReportConsumerInfo": "string"
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

deleteIrs⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/account/deleteIrs
POST /nexum/627/2022.01/account/deleteIrs HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteIrsDistribution⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
IrsDistributionLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/account/deleteIrsDistribution
POST /nexum/627/2022.01/account/deleteIrsDistribution HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "IrsDistributionLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteIrsName⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
IrsNameLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/account/deleteIrsName
POST /nexum/627/2022.01/account/deleteIrsName HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "IrsNameLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getIrs⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrs
POST /nexum/627/2022.01/account/getIrs HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsSelectFields
POST /nexum/627/2022.01/account/getIrsSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "SelectableFields": {
    "IncludeAllIrsFields": false,
    "IrsFields": {
      "Locator": true,
      "IrsCode": true,
      "IrsPlan": true,
      "OpenDate": true,
      "ContributionYear": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getIrsSelectFieldsFilterChildren⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsSelectFieldsFilterChildren
POST /nexum/627/2022.01/account/getIrsSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "SelectableFields": {
    "IncludeAllIrsFields": true,
    "IrsFields": {
      "ActualMaxContribution": true,
      "ContrLastYear": [
        0
      ],
      "ContrThisYear": [
        0
      ],
      "ContributionYear": true,
      "DistrLastYear": [
        0
      ],
      "DistrThisYear": [
        0
      ],
      "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
    },
    "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": [
          0
        ]
      }
    },
    "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
      }
    }
  },
  "ChildrenSearchFilter": {
    "IrsDistributionFilter": {
      "Query": "string"
    },
    "IrsNameFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsPagedList⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getIrsPagedList
POST /nexum/627/2022.01/account/getIrsPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsListSelectFields
POST /nexum/627/2022.01/account/getIrsListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SelectableFields": {
    "IncludeAllIrsFields": true,
    "IrsFields": {
      "ActualMaxContribution": true,
      "ContrLastYear": [
        0
      ],
      "ContrThisYear": [
        0
      ],
      "ContributionYear": true,
      "DistrLastYear": [
        0
      ],
      "DistrThisYear": [
        0
      ],
      "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
    },
    "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": [
          0
        ]
      }
    },
    "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
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsPagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getIrsPagedListSelectFields
POST /nexum/627/2022.01/account/getIrsPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllIrsFields": false,
    "IrsFields": {
      "Locator": true,
      "IrsCode": true,
      "IrsPlan": true,
      "OpenDate": true,
      "ContributionYear": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getIrsDistribution⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
IrsDistributionLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsDistribution
POST /nexum/627/2022.01/account/getIrsDistribution HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "IrsDistributionLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsDistributionSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
IrsDistributionLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsDistributionSelectFields
POST /nexum/627/2022.01/account/getIrsDistributionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "IrsDistributionLocator": 0,
  "SelectableFields": {
    "IncludeAllIrsDistributionFields": false,
    "IrsDistributionFields": {
      "Locator": true,
      "Type": true,
      "DistributionCode": true,
      "DistributionMethod": true,
      "Amount": true,
      "FedWholdPercent": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getIrsDistributionPagedList⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getIrsDistributionPagedList
POST /nexum/627/2022.01/account/getIrsDistributionPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsDistributionListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsDistributionListSelectFields
POST /nexum/627/2022.01/account/getIrsDistributionListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "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": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsDistributionPagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getIrsDistributionPagedListSelectFields
POST /nexum/627/2022.01/account/getIrsDistributionPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllIrsDistributionFields": false,
    "IrsDistributionFields": {
      "Locator": true,
      "Type": true,
      "DistributionCode": true,
      "DistributionMethod": true,
      "Amount": true,
      "FedWholdPercent": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getIrsName⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
IrsNameLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsName
POST /nexum/627/2022.01/account/getIrsName HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "IrsNameLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsNameSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
IrsNameLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsNameSelectFields
POST /nexum/627/2022.01/account/getIrsNameSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "IrsNameLocator": 0,
  "SelectableFields": {
    "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsNamePagedList⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getIrsNamePagedList
POST /nexum/627/2022.01/account/getIrsNamePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsNameListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getIrsNameListSelectFields
POST /nexum/627/2022.01/account/getIrsNameListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "SelectableFields": {
    "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getIrsNamePagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getIrsNamePagedListSelectFields
POST /nexum/627/2022.01/account/getIrsNamePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchIrsSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/searchIrsSelectFields
POST /nexum/627/2022.01/account/searchIrsSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SelectableFields": {
    "IncludeAllIrsFields": true,
    "IrsFields": {
      "ActualMaxContribution": true,
      "ContrLastYear": [
        0
      ],
      "ContrThisYear": [
        0
      ],
      "ContributionYear": true,
      "DistrLastYear": [
        0
      ],
      "DistrThisYear": [
        0
      ],
      "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
    },
    "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": [
          0
        ]
      }
    },
    "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
      }
    }
  },
  "SearchFilter": {
    "Query": "string",
    "IrsChildrenFilter": {
      "IrsDistributionFilter": {
        "Query": "string"
      },
      "IrsNameFilter": {
        "Query": "string"
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchIrsPagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Querystringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/searchIrsPagedSelectFields
POST /nexum/627/2022.01/account/searchIrsPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllIrsFields": false,
    "IrsFields": {
      "Locator": true,
      "IrsCode": true,
      "IrsPlan": true,
      "OpenDate": true,
      "ContributionYear": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchIrsDistributionSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/searchIrsDistributionSelectFields
POST /nexum/627/2022.01/account/searchIrsDistributionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "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": [
        0
      ]
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchIrsDistributionPagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Querystringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/searchIrsDistributionPagedSelectFields
POST /nexum/627/2022.01/account/searchIrsDistributionPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllIrsDistributionFields": false,
    "IrsDistributionFields": {
      "Locator": true,
      "Type": true,
      "DistributionCode": true,
      "DistributionMethod": true,
      "Amount": true,
      "FedWholdPercent": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchIrsNameSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/searchIrsNameSelectFields
POST /nexum/627/2022.01/account/searchIrsNameSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "SelectableFields": {
    "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
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchIrsNamePagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
IrsLocatorintegeroptional
Querystringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/searchIrsNamePagedSelectFields
POST /nexum/627/2022.01/account/searchIrsNamePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "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
    }
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

updateIrsByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
IrsLocatorintegeroptional
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/updateIrsByID
POST /nexum/627/2022.01/account/updateIrsByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "IrsUpdatableFields": {
    "MaxContribution": 0,
    "MsaHolderCode": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateIrsDistributionByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
IrsDistributionLocatorintegeroptional
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/updateIrsDistributionByID
POST /nexum/627/2022.01/account/updateIrsDistributionByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "IrsLocator": 0,
  "IrsDistributionLocator": 0,
  "IrsDistributionUpdatableFields": {
    "Amount": 0,
    "DistributionDay1": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateIrsNameByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
IrsNameLocatorintegeroptional
AccountNumberstringoptional
IrsLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/updateIrsNameByID
POST /nexum/627/2022.01/account/updateIrsNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "IrsNameLocator": 0,
  "IrsNameUpdatableFields": {
    "ActiveDuty": 0,
    "ActiveDutySeparationDate": "string",
    "ActiveDutyStartDate": "string",
    "ActiveDutyVerificationDate": "string",
    "AddrExpDate": "string",
    "AddressType": 0,
    "AltEmail": "string",
    "BeneficialOwner": 0,
    "BeneficialPercent": 0,
    "BeneficiaryPercent": 0,
    "BirthDate": "string",
    "CarrierRoute": "string",
    "Chapter4StatusCode": "string",
    "City": "string",
    "Confidential": 0,
    "Country": "string",
    "CountryCode": "string",
    "CreditReportAddrIndicator": "string",
    "CreditReportAddrIndicatorDate": "string",
    "CreditReportConsumerInfo": "string"
  },
  "AccountNumber": "string",
  "IrsLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}