POST api/UserInstitution/CreateUserInstitutionWithRefresh
Create a UserInstitution and retrieve all transactions for all accounts under the UserInstitution. UserInstitution is a user login account with an institution.
Request Information
URI Parameters
None.
Body Parameters
CreateUserInstitutionParams| Name | 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": "82f4dfb1-f83f-46b2-aa7e-6db8e21a8efd",
"InstitutionID": "35383341-1a1b-4dfc-b30e-1beb7bbd900d",
"UserName": "Bob1234",
"Password": "Password5678!",
"PIN": "7654", (optional)
"CompanyID": "BobCorp1" (optional)
}
application/xml, text/xml
Coming soon.
Response Information
Resource Description
Creating UserInstitution with refresh will trigger a job. Such job takes longer to complete but saves users from making separate requests for retrieving accounts and transactions.
CreateUserInstitutionJobTracker| Name | 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": "b4b939a4-4440-43b4-b6b1-df66b5074e4a",
"UserInstitutionID": "dbf82ab6-4237-4e04-8b23-e12f93980e51"
}
application/xml, text/xml
Coming soon.