Skip to content
NexumAPI Docs

Institution⁠

Perform various operations for Symitar parameters.

Operations⁠

getInstitutionSelectFields⁠

POST

Execute the persistent ParameterService getInstitutionSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InstitutionBranchintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getInstitutionSelectFields
POST /nexum/627/persistent/parameter/getInstitutionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "InstitutionBranch": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getInstitutionPagedListSelectFields⁠

POST

Execute the persistent ParameterService getInstitutionPagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchInstitutionPagedSelectFields⁠

POST

Execute the persistent ParameterService searchInstitutionPagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateInstitutionByID⁠

POST

Execute the persistent ParameterService updateInstitutionByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InstitutionBranchintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updateInstitutionByID
POST /nexum/627/persistent/parameter/updateInstitutionByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "InstitutionBranch": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "InstitutionFields": {
    "Branch": 0,
    "CfpbWebAddress1": "string",
    "CfpbWebAddress2": "string",
    "City": "string",
    "CountryCode": "string",
    "CtrApprover": "string",
    "CtrApproverTitle": "string",
    "CtrContact": "string",
    "CtrContactPhone": "string",
    "CtrContactPhoneExt": "string",
    "CtrPreparer": "string",
    "Ein": "string",
    "ExtraAddress": "string",
    "FiEmail": "string",
    "FiPhone": "string",
    "HudPhone": "string",
    "HudWebAddress1": "string",
    "HudWebAddress2": "string",
    "Name": "string",
    "RoutingNumber": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}