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
NameDescriptionTypeAdditional 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

Sample:
{
  "UserID": "5abd75b7-1b2e-4227-91e6-f219d6c07b9d",
  "InstitutionID": "d2da5e74-e7cf-4271-a12f-81a7d7b4039f",
  "UserName": "sample string 3",
  "Password": "sample string 4",
  "PIN": "sample string 5",
  "CompanyID": "sample string 6"
}

application/xml, text/xml

Sample:
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
NameDescriptionTypeAdditional 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

Sample:
{
  "JobID": "6d54af3f-7ddc-4fa5-8182-0d233cae59cf",
  "UserInstitutionID": "a4171893-9178-4e95-b22b-59a0ee46cc6a"
}

application/xml, text/xml

Sample:
Coming soon.