POST api/UserInstitution/CreateUserInstitutionWithFullAccountNumbers
Create user institution and get full account number, routing number and account holder name, address information for all accounts under UserInstitution.
Request Information
URI Parameters
None.
Body Parameters
CreateUserInstitutionParamsName | Description | Type | Additional information |
---|---|---|---|
UserID |
Guid-type UserID can be found under Developer Profile -> Direct Auth. |
globally unique identifier |
None. |
InstitutionID |
Guid-type InstitutionID can be looked up by api/Institution/GetInstitutionByName method. If an institution does not exist in Sophtron's list, use api/Institution/AddInstitution to add it to the list. |
globally unique identifier |
None. |
UserName |
UserName for login account. |
string |
None. |
Password |
Password for login account. |
string |
None. |
PIN |
PIN for login account (Optional). |
string |
None. |
CompanyID |
CompanyID for business login account (Optional). |
string |
None. |
Request Formats
application/json, text/json
{ "UserID": "ec0e48c6-05f4-4ea4-86b7-b2ccb6bc4f22", "InstitutionID": "17356950-762d-4642-a95a-ea3e477240db", "UserName": "sample string 3", "Password": "sample string 4", "PIN": "sample string 5", "CompanyID": "sample string 6" }
application/xml, text/xml
Coming soon.
Response Information
Resource Description
JobID of the new job triggerd by trying to create user institution and retrieve full account number for all accounts. Use api/Job/GetJobInformationByID with this JobID to look up current job's MFA information and status.
CreateUserInstitutionJobTrackerName | Description | Type | Additional information |
---|---|---|---|
JobID |
Guid-type JobID is used to track current job. Use api/Job/GetJobInformationByID with this JobID to look up current job's MFA information and status. |
globally unique identifier |
None. |
UserInstitutionID |
Guid-type UserInstitutionID is used to track the UserInstitution just created. After the current CreateUserInstitution job succeeds, use api/UserInstitution/GetUserInstitutionAccounts to get retrieved accounts belonging to this UserInstitution. |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{ "JobID": "c29530ed-fccd-490c-a646-61132585cdc8", "UserInstitutionID": "c14fbc94-5a4b-49e7-9a33-6c2a1452452f" }
application/xml, text/xml
Coming soon.