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
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": "7000706c-6bcd-4774-a26d-a5ae942bb1ff",
"InstitutionID": "2982ea60-0b6e-4032-828b-d459441770b8",
"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.
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": "8d0af7b3-6173-4db6-a075-55363e9a3f50",
"UserInstitutionID": "e951a9dd-f1f5-4d3b-b683-6e6bb8100809"
}
application/xml, text/xml
Coming soon.