FindByService

Find accounts based on various search methods.

Symitar eDocs References: SymXchange FindBy Service

Operations

findByActiveCard

post

Finds an account by active card.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CardNumberstringRequired

The card number used to search for accounts.

Example: 1234567890123456

Responses

200

Successful operation.

application/json

post

/findByActiveCard

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CardNumber": 1234567890123456,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "AccountNumber": 13824
}

findByAnyCard

post

Finds an account by any card.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CardNumberstringRequired

The card number used to search for accounts.

Example: 1234567890123456

Responses

200

Successful operation.

application/json

post

/findByAnyCard

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CardNumber": 1234567890123456,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "AccountNumber": [
    "0000013824",
    "0000013826"
  ]
}

findByHomeUser

post

Finds an account by home user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

HomeBankingUserNamestringRequired

The home banking user used to search for accounts.

Example: john_doe

Responses

200

Successful operation.

application/json

post

/findByHomeUser

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "HomeBankingUserName": "john_doe",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "AccountNumber": 13824
}

findByMICR

post

Finds an account by MICR.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

MICRstringRequired

The Magnetic Ink Character Recognition (MICR) number used to search for accounts.

Example: 12345678

DraftstringRequired

The draft number used to search for accounts.

Example: 987654321

Responses

200

Successful operation.

application/json

post

/findByMICR

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MICR": 12345678,
  "Draft": 987654321,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Result": {
    "AccountNumber": "0000013826",
    "Id": "0020",
    "IdType": "SHARE"
  },
  "customFields": {
    "appId": "glaci"
  }
}

findByLookup

post

Finds an account by lookup.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LookupTypeintegerRequired

The type of lookup used to search for accounts.

Example: 0

LookupNumberstringRequired

The lookup number used to search for accounts.

Example: TESTING

Responses

200

Successful operation.

application/json

post

/findByLookup

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LookupType": 0,
  "LookupNumber": "TESTING",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Result": {
    "AccountNumber": "0000014117",
    "Id": "",
    "IdType": "NONE"
  },
  "customFields": {
    "appId": "glaci"
  }
}

findBySSN

post

Finds an account by SSN.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SSNstringRequired

The Social Security Number (SSN) used to search for accounts.

Example: 849705024

Responses

200

Successful operation.

application/json

post

/findBySSN

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SSN": 849705024,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "AccountNumber": "0000013824",
  "customFields": {
    "appId": "glaci"
  }
}

findByShortName

post

Finds an account by short name.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ShortNamestringRequired

The short name used to search for accounts.

Example: John D.

Responses

200

Successful operation.

application/json

post

/findByShortName

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ShortName": "John D.",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "AccountNumber": [
    "0000013824",
    "0000013826"
  ]
}