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": "f1a4fa54-3732-4650-8a97-a2f2f31bb8dc", "InstitutionID": "8d7ab025-656d-44ca-ab5a-915fb94654fa", "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": "3d18c8a2-3bd4-4721-b995-1431c19d3957", "UserInstitutionID": "2f30f915-f6e3-4df9-8fba-73436524593f" }
application/xml, text/xml
Coming soon.