POST api/UserInstitution/CreateUserInstitution
Create a UserInstitution. UserInstitution is a user login account with an institution.
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": "82f4dfb1-f83f-46b2-aa7e-6db8e21a8efd", "InstitutionID": "35383341-1a1b-4dfc-b30e-1beb7bbd900d", "UserName": "Bob1234", "Password": "Password5678!", "PIN": "7654", (optional) "CompanyID": "BobCorp1" (optional) }
application/xml, text/xml
Coming soon.
Response Information
Resource Description
Creating UserInstitution will trigger a job,
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": "6e2c3acc-6eb6-4f64-b805-19c63c0b3f14", "UserInstitutionID": "262e6555-f7ab-4ba6-83da-5ae3c7efa0cb" }
application/xml, text/xml
Coming soon.