MbraddressService
Operations
Retrieves a member address.
Successful operation.
POST /nexum/627/2022.01/mbraddress/getMbrAddress HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddress": {
"AddrCreateDate": "2026-01-01",
"AddrDisconnectDate": "2026-01-01",
"AddrExpDate": "2026-01-01",
"AddrFmLastDate": "2026-01-01",
"AddrFmLastPurgeDate": "2026-01-01",
"AddrRecordChangeDate": "2026-01-01",
"AddressType": 1,
"CarrierRoute": "text",
"City": "text",
"Country": "text",
"CountryCode": "text",
"ExtraAddress": "text",
"MbrAddrFileType": 1,
"MbrAddrNumber": "text",
"State": "text",
"Street": "text",
"ZipCode": "text",
"MbrAddressFmHistoryList": {
"hasReachedMaximumListSize": true,
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
]
},
"Headquarters": 1
}
}Retrieves a member address with selected fields.
Successful operation.
POST /nexum/627/2022.01/mbraddress/getMbrAddressSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 333
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"MbrAddressMbrAddrNumber": "20080920000007924",
"SelectableFields": {
"IncludeAllMbrAddressFields": false,
"MbrAddressFields": {
"MbrAddrNumber": true,
"Street": true,
"City": true,
"State": true,
"ZipCode": true
}
},
"nxAttributes": {
"customFields": {
"appId": "{application-id}"
}
}
}Successful operation.
{
"MbrAddress": {
"MbrAddrNumber": "20080920000007924",
"Street": "123 MAIN STREET",
"City": "NEW YORK",
"State": "NY",
"ZipCode": "10001"
},
"MessageId": "getMbrAddressSelectFields"
}Retrieves a member address with selected fields and filtered children.
Successful operation.
POST /nexum/627/2022.01/mbraddress/getMbrAddressSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1437
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"SelectableFields": {
"IncludeAllMbrAddressFields": true,
"MbrAddressFields": {
"AddrCreateDate": true,
"AddrDisconnectDate": true,
"AddrExpDate": true,
"AddrFmLastDate": true,
"AddrFmLastPurgeDate": true,
"AddrRecordChangeDate": true,
"AddressType": true,
"CarrierRoute": true,
"City": true,
"Country": true,
"CountryCode": true,
"ExtraAddress": true,
"Headquarters": true,
"MbrAddrFileType": true,
"MbrAddrNumber": true,
"State": true,
"Street": true,
"ZipCode": true
},
"MbrAddressFmHistorySelectableFields": {
"IncludeAllMbrAddressFmHistoryFields": true,
"MbrAddressFmHistoryFields": {
"AccountNumber": true,
"BatchSequence": true,
"Branch": true,
"ConfirmationNumber": true,
"ConfirmationSeq": true,
"ConsoleNumber": true,
"DataType": true,
"FieldName": true,
"FieldNumber": true,
"FmType": true,
"Id": true,
"IdType": true,
"LastFmDate": true,
"NewCharacter": true,
"NewDate": true,
"NewMoney": true,
"NewNumber": true,
"NewRate": true,
"OldCharacter": true,
"OldDate": true,
"OldMoney": true,
"OldNumber": true,
"OldRate": true,
"PostDate": true,
"PostTime": true,
"ProcessorUser": true,
"RecordName": true,
"RecordType": true,
"SecurityLevels": true,
"SequenceNumber": true,
"SubFieldNumber": true,
"UserNumber": true,
"UserOverride": true
}
}
},
"ChildrenSearchFilter": {
"MbrAddressFmHistoryFilter": {
"Query": "text"
}
},
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddress": {
"AddrCreateDate": "2026-01-01",
"AddrDisconnectDate": "2026-01-01",
"AddrExpDate": "2026-01-01",
"AddrFmLastDate": "2026-01-01",
"AddrFmLastPurgeDate": "2026-01-01",
"AddrRecordChangeDate": "2026-01-01",
"AddressType": 1,
"CarrierRoute": "text",
"City": "text",
"Country": "text",
"CountryCode": "text",
"ExtraAddress": "text",
"MbrAddrFileType": 1,
"MbrAddrNumber": "text",
"State": "text",
"Street": "text",
"ZipCode": "text",
"MbrAddressFmHistoryList": {
"hasReachedMaximumListSize": true,
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
]
},
"Headquarters": 1
}
}Retrieves a paged list of member addresses from history.
Successful operation.
Sample data for Token
POST /nexum/627/2022.01/mbraddress/getMbrAddressFmHistoryPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 324
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
],
"Token": "text"
}Retrieves a list of member addresses with selected fields from history.
Successful operation.
POST /nexum/627/2022.01/mbraddress/getMbrAddressFmHistoryListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 917
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"SelectableFields": {
"IncludeAllMbrAddressFmHistoryFields": true,
"MbrAddressFmHistoryFields": {
"AccountNumber": true,
"BatchSequence": true,
"Branch": true,
"ConfirmationNumber": true,
"ConfirmationSeq": true,
"ConsoleNumber": true,
"DataType": true,
"FieldName": true,
"FieldNumber": true,
"FmType": true,
"Id": true,
"IdType": true,
"LastFmDate": true,
"NewCharacter": true,
"NewDate": true,
"NewMoney": true,
"NewNumber": true,
"NewRate": true,
"OldCharacter": true,
"OldDate": true,
"OldMoney": true,
"OldNumber": true,
"OldRate": true,
"PostDate": true,
"PostTime": true,
"ProcessorUser": true,
"RecordName": true,
"RecordType": true,
"SecurityLevels": true,
"SequenceNumber": true,
"SubFieldNumber": true,
"UserNumber": true,
"UserOverride": true
}
},
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddressFmHistoryList": {
"hasReachedMaximumListSize": true,
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
]
}
}Searches member addresses from history with selected fields.
Successful operation.
POST /nexum/627/2022.01/mbraddress/searchMbrAddressFmHistorySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 949
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"SelectableFields": {
"IncludeAllMbrAddressFmHistoryFields": true,
"MbrAddressFmHistoryFields": {
"AccountNumber": true,
"BatchSequence": true,
"Branch": true,
"ConfirmationNumber": true,
"ConfirmationSeq": true,
"ConsoleNumber": true,
"DataType": true,
"FieldName": true,
"FieldNumber": true,
"FmType": true,
"Id": true,
"IdType": true,
"LastFmDate": true,
"NewCharacter": true,
"NewDate": true,
"NewMoney": true,
"NewNumber": true,
"NewRate": true,
"OldCharacter": true,
"OldDate": true,
"OldMoney": true,
"OldNumber": true,
"OldRate": true,
"PostDate": true,
"PostTime": true,
"ProcessorUser": true,
"RecordName": true,
"RecordType": true,
"SecurityLevels": true,
"SequenceNumber": true,
"SubFieldNumber": true,
"UserNumber": true,
"UserOverride": true
}
},
"SearchFilter": {
"Query": "text"
},
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddressFmHistoryList": {
"hasReachedMaximumListSize": true,
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
]
}
}Retrieves a paged list of member addresses with selected fields from history.
Successful operation.
Sample data for Token
POST /nexum/627/2022.01/mbraddress/getMbrAddressFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1011
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"SelectableFields": {
"IncludeAllMbrAddressFmHistoryFields": true,
"MbrAddressFmHistoryFields": {
"AccountNumber": true,
"BatchSequence": true,
"Branch": true,
"ConfirmationNumber": true,
"ConfirmationSeq": true,
"ConsoleNumber": true,
"DataType": true,
"FieldName": true,
"FieldNumber": true,
"FmType": true,
"Id": true,
"IdType": true,
"LastFmDate": true,
"NewCharacter": true,
"NewDate": true,
"NewMoney": true,
"NewNumber": true,
"NewRate": true,
"OldCharacter": true,
"OldDate": true,
"OldMoney": true,
"OldNumber": true,
"OldRate": true,
"PostDate": true,
"PostTime": true,
"ProcessorUser": true,
"RecordName": true,
"RecordType": true,
"SecurityLevels": true,
"SequenceNumber": true,
"SubFieldNumber": true,
"UserNumber": true,
"UserOverride": true
}
},
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
],
"Token": "text"
}Searches member addresses from history with pagination and selected fields.
Sample data for Query
Successful operation.
Sample data for Token
POST /nexum/627/2022.01/mbraddress/searchMbrAddressFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1026
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "text"
},
"UserNumberCredentials": {
"UserNumber": 1,
"Password": "text"
},
"TokenCredentials": {
"TokenId": "text"
}
},
"MbrAddressMbrAddrNumber": "text",
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"SelectableFields": {
"IncludeAllMbrAddressFmHistoryFields": true,
"MbrAddressFmHistoryFields": {
"AccountNumber": true,
"BatchSequence": true,
"Branch": true,
"ConfirmationNumber": true,
"ConfirmationSeq": true,
"ConsoleNumber": true,
"DataType": true,
"FieldName": true,
"FieldNumber": true,
"FmType": true,
"Id": true,
"IdType": true,
"LastFmDate": true,
"NewCharacter": true,
"NewDate": true,
"NewMoney": true,
"NewNumber": true,
"NewRate": true,
"OldCharacter": true,
"OldDate": true,
"OldMoney": true,
"OldNumber": true,
"OldRate": true,
"PostDate": true,
"PostTime": true,
"ProcessorUser": true,
"RecordName": true,
"RecordType": true,
"SecurityLevels": true,
"SequenceNumber": true,
"SubFieldNumber": true,
"UserNumber": true,
"UserOverride": true
}
},
"Query": "text",
"nxAttributes": {
"customFields": {}
}
}Successful operation.
{
"MbrAddressFmHistory": [
{
"AccountNumber": "text",
"BatchSequence": 1,
"Branch": 1,
"ConfirmationNumber": "text",
"ConfirmationSeq": 1,
"ConsoleNumber": 1,
"DataType": 1,
"FieldName": "text",
"FieldNumber": 1,
"FmType": 1,
"Id": "text",
"IdType": 1,
"LastFmDate": "2026-01-01",
"NewCharacter": "text",
"NewDate": "2026-01-01",
"NewMoney": 1,
"NewNumber": 1,
"NewRate": 1,
"OldCharacter": "text",
"OldDate": "2026-01-01",
"OldMoney": 1,
"OldNumber": 1,
"OldRate": 1,
"PostDate": "2026-01-01",
"PostTime": 1,
"ProcessorUser": 1,
"RecordName": "text",
"RecordType": 1,
"SecurityLevels": 1,
"SequenceNumber": 1,
"SubFieldNumber": 1,
"UserNumber": 1,
"UserOverride": 1
}
],
"Token": "text"
}Updates a member address by its ID.
Successful operation.
POST /nexum/627/2022.01/mbraddress/updateMbrAddressByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"MbrAddressMbrAddrNumber": "NEXW45",
"MbrAddressUpdatableFields": {
"Street": "123 TEST ST",
"City": "TEST",
"State": "CA",
"ZipCode": "90000",
"AddressType": 0
},
"nxAttributes": {
"customFields": {
"appId": "{application-id}"
}
}
}Successful operation.
{
"UpdateStatus": {
"isAllFieldsUpdateSuccess": true,
"FailedUpdateStatus": []
},
"MessageId": "updateMbrAddressByID"
}Creates a member address.
Successful operation.
POST /nexum/627/2022.01/mbraddress/createMbrAddress HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 249
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"nxAttributes": {
"customFields": {
"appId": "{application-id}"
}
},
"MbrAddressCreatableFields": {
"Street": "123 TEST ST",
"City": "TEST",
"State": "CA",
"ZipCode": "90000",
"AddressType": 0
}
}Successful operation.
{
"MbrAddressMbrAddrNumber": "20101280000000276",
"MessageId": "createMbrAddress"
}Last updated
Was this helpful?