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": "e3d2e148-2634-48e3-8e4b-4ac7a9478981", "InstitutionID": "446bdff9-f86d-42b8-8c81-52aade791aa6", "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": "d7c177d0-1797-42a1-b0c0-ab81bda86a69", "UserInstitutionID": "60637bd7-567a-41c4-9a66-b869c1bc907b" }
application/xml, text/xml
Coming soon.