POST api/UserInstitution/CreateUserInstitution

Create a UserInstitution. UserInstitution is a user login account with an institution.

Request Information

URI Parameters

None.

Body Parameters

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

Sample:

{ 
 "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

Sample:

Coming soon.

Response Information

Resource Description

Creating UserInstitution will trigger a job,

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

Sample:

{
  "JobID": "b3e57392-d0b6-40c8-9511-560d63cf6c3b",
  "UserInstitutionID": "55a9927e-70e1-4248-bc35-b5cc7f0879ef"
}

application/xml, text/xml

Sample:

Coming soon.