POST api/UserInstitution/CreateUserInstitutionWithProfileInfo
Create user institution and get profile information including owner 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": "f68c1c0b-8403-49d0-a1a0-bb80b6e8f586", "InstitutionID": "add353f0-77e3-4e66-94fe-e1a9cd682d66", "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 profile information. 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": "31a032b7-385d-40a1-a2d3-562991661798", "UserInstitutionID": "96d4328a-9613-47cc-953a-dd89ee9c2ce4" }
application/xml, text/xml
Coming soon.