Sophtron Open API Guide

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

Create a UserInstitution and retrieve all transactions for all accounts under the UserInstitution. UserInstitution is a user login account with an institution.

Create a UserInstitution and retrieve the complete history of transactions for all accounts under the UserInstitution. UserInstitution is a user login account with an institution.

No documentation available.

Update a UserInstitution with new login information such as new username or new password.

Delete a UserInstitution. Note: all of the UserInstitutionAccounts under the UserInstitution, as well as Transactions under these accounts will be deleted as well.

Retry adding a UserInstitution if the previous CreateUserInstitution job did not succeed. Note: to avoid adding duplicate UserInstitutions, use the UserInstitutionID returned from api/UserInstitution/CreateUserInstitution to retry.

Get owner's profile information, such as name, address, phone numbers of a UserInstitution.

Get all UserInstitutions created by the current Sophtron user account.

Get a UserInstitution's information by UserInstitutionID

Get all UserInstitutionAccounts retrieved under a UserInstitution, e.g. "Primary Checking", "Savings" under login account "Bob1234" with "Chase Bank".

Refresh all accounts' transactions under the same UserInstitution (login).

Refresh all accounts' complete history under the same UserInstitution (login).

Retrieve full account number and routing number for all accounts under the same UserInstitution (login).

Create user institution and get full account number, routing number and account holder name, address information for all accounts under UserInstitution.

Create user institution and get profile information including owner name, address information for all accounts under UserInstitution.

Refresh user institution and get rewards information including rewards unit, rewards balance for all accounts under UserInstitution.

Create user institution and get rewards information including rewards unit, rewards balance for all accounts under UserInstitution.

Retry adding a UserInstitution with rewards information if the previous CreateUserInstitution job did not succeed. Note: to avoid adding duplicate UserInstitutions, use the UserInstitutionID returned from api/UserInstitution/CreateUserInstitution to retry.

Get UserInstitutionAccount information by account ID

Refresh a UserInstitutionAccount to download transactions under the account.

Update check images for transactions under a given UserInstitutionAccount

Get account's full account number, routing number and account holder name and address.

Get Job information by JobID

If the institution requests one or more security questions for authentication, use this method to update the job with security answers to the questions.

If the institution requests user to read a captcha image for authentication, use this method to update the job with texts or numbers user read from the captcha image.

If the institution requests to send a security token for authentication, use this method to update the job with required information at each step of the token verification process.

Get transactions within a given date range from a UserInstitutionAccount

Get holdings by UserInstitutionAccountID

Health Check returns current API status. If returned value is "Online" API service is currently running without issues.

Add a new institution if it does not already exist in Sophtron's institution list.

Get institution by given institution name

Get all institutions under the current Sophtron account

Get institution by routing number

Get institution by given institution ID

Get institution details including routing number(s), login form fields by given institution ID