POST api/UserInstitution/CreateUserInstitutionWithFullHistory
Create a UserInstitution and retrieve the complete history of 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": "c71c6eb6-feec-4df0-a9a5-377b4ba8c7bb",
"InstitutionID": "c816f4f0-325f-4103-8663-2ac8f3f0e23a",
"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
Creating UserInstitution with full history will trigger a job. Such job takes longer to complete but retrieves transaction history as far back as possible to give a complete picture of the account's history.
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": "cd9446c4-118f-4ab9-8fd8-0572451d20f4",
"UserInstitutionID": "a86bd1bb-9c51-42e8-94cb-f24f38ddafd2"
}
application/xml, text/xml
Coming soon.