Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v1.0
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Guides
API Reference
Changelog
Discussions
Options
Search
All
Pages
Start typing to search…
JUMP TO
Portfolio+ Retail API
Retail Accounts
Options
optns
GET Account List
get
Add Account
post
Options
optns
GET Specific Retail Account
get
Update Specific Retail Account
patch
Access to Funds
Options
optns
Retrieve Access to Funds details
get
Account Balance
Options
optns
GET Account Balance
get
Options
optns
Query the amount that would need to be adjusted in order to close a particular retail account.
get
Account Statement
Options
optns
GET All Account Statements
get
Options
optns
GET Specific Document Content
get
Account Note
Options
optns
GET Specific Account Note
get
Update Account Notes
put
Account Transactions
Options
optns
GET Account Transaction History
get
Options
optns
GET Specific Account History
get
Options
optns
GET Specific Transaction Detail
get
Account Transfer
Options
optns
Create Account Transfer
post
Bank Draft
Options
optns
Create Bank Draft
post
Bill Payment
Options
optns
Create Bill Payment
post
Bulk Transfer
Options
optns
Create Bulk Transfer
post
Cashed Cheques
Options
optns
GET Cashed Cheques
get
Cheque Detail
Options
optns
GET Specific Cheque
get
Credit Memo
Options
optns
POST Credit Memo
post
Date Validation
Options
optns
GET Date Validation
get
Debit Memo
Options
optns
POST Debit Memo
post
Deposit
Options - Not currently implemented
optns
POST Deposit - Not currently implemented
post
DIG Status
Options - Not currently implemented
optns
GET DIG Status - Not currently implemented
get
External Account Management
Options
optns
Query for External Accounts
get
Add external account
post
Options
optns
Query specific external institution account
get
Update an existing, external account for the client
put
Remove an existing, external account for the client
delete
Fee
Options
optns
POST Fee
post
Hold Funds
Options
optns
GET Account Hold
get
POST Hold Funds
post
Options
optns
PATCH Hold Funds
patch
Internal Account Management
Options
optns
Query internal accounts
get
Create internal account
post
Options
optns
Query specific internal institution account
get
Update internal account
put
Unlink an internal account for the client
delete
Joint Owners
Options
optns
GET Joint Owners List
get
Create Joint Owner
post
Options
optns
GET Specific Joint Owner
get
Update Specific Joint Owner
put
Delete Joint Owner
delete
Loan Payment
Options
optns
POST Loan Payment
post
Pending Interest and Fees
Options
optns
Query Pending Interest and Fees
get
Options
optns
Query Pending Interest and Fees by Account Number
get
Options
optns
GET Pending Interest and Fees by Transaction Date
get
Options
optns
Query Specific Pending Interest or Fee
get
Update Specific Pending Interest or Fee
patch
Post Interest
Options
optns
POST Interest, Fees, and LOC Interest
post
Pre-Authorized Transaction Management
Options
optns
GET Client PAT
get
Options
optns
GET PATs By Account
get
Create PAT
post
Options
optns
GET Specific PAT by Sequence
get
Update Specific PAT
patch
Delete PAT
delete
Retail Checklists
Options
optns
GET All Checklists
get
Create Checklist Item
post
Options
optns
GET Checklist Items By Type
get
Options
optns
GET Specific Checklist Item
get
Update Checklist Item
patch
Delete Checklist Item
delete
Retail Line of Credit
Options
optns
Query Account Line of Credit
get
Update specific Line of Credit
patch
Transaction Reverse
Options
optns
POST Account Transaction Reverse
post
System Admin Retail Lookups
Options
optns
GET Account Type List
get
Options
optns
GET Specific Account Type
get
Options
optns
GET Account Type Dormant Fees
get
Options
optns
GET Account Type Electronic Funds Transfer Fees
get
Options
optns
GET Account Type External Transaction Holds
get
Options
optns
GET Pre-Authorized Transfer Defaults
get
Options
optns
GET Transaction Types
get
Options
optns
GET Transaction Code
get
Options
optns
GET TransactionCode
get
Options
optns
GET Transaction Code Descriptions
get
Options - Not currently implemented
optns
GET Vendor Services - Not currently implemented
get
Options
optns
GET All Bill Vendors
get
Options
optns
GET All General Ledger Transaction Types
get
Options
optns
GET General Ledger Transaction Types By Company
get
Options
optns
GET Interest Rates List
get
Options
optns
GET PAT Frequencies
get
Options
optns
GET PAT Types
get
Options
optns
GET Retail Account Owner Types
get
Options
optns
GET Retail Account Statement Types
get
Options
optns
Query Retail Default Values
get
Options
optns
GET Hold Reasons
get
Options
optns
Query list of waive fee reason codes
get
Create a waive fee reason
post
Options
optns
Query specific waive fee reason code.
get
Update an existing waive fee reason
patch
Remove an existing waive fee reason from the system
delete
Term Deposits API
Term Deposits Search
Options
optns
GET Generic Term Deposit Search
get
Create a term deposit
post
Options
optns
GET Generic Term Deposit Search By Company
get
Options
optns
GET Term Deposit Details
get
Options
optns
GET Term Deposit Details
get
Term Deposit Checklists
Options
optns
GET Checklist Items For Specific Term Deposit
get
Options
optns
GET Checklist Items By Type
get
Options
optns
GET A Specific Checklist Item
get
Term Deposits Client Profile
Options
optns
Get all associated Term Deposit Rate Codes for the specified Client.
get
Term Deposit Comments
Options
optns
GET All Comments
get
Options
optns
GET Specific Comment
get
Term Deposit Notes
Options
optns
GET All Notes
get
Options
optns
GET Specific Note
get
Term Deposits PAD Detail
Options
optns
GET Term Deposits PAD Details
get
Term Deposits PAD Details
put
Term Deposits Payment History
Options
optns
GET Term Deposit Payment History
get
Term Deposits Related Clients
Options
optns
GET Term Deposit Related Clients (Nominee)
get
Options
optns
GET Term Deposit Related Clients (Client Name)
get
Create Related Client for a Term Deposit (Client Name)
post
Options
optns
GET Term Deposit Related Clients (Client Name) by Client Number
get
Options
optns
Update a Related Client for a Term Deposit (Client Name)
patch
Delete a Related Client for a Term Deposit (Client Name)
delete
Term Deposits Registration
Options
optns
GET Term Deposit Registration
get
UPDATE Term Deposit Registration
put
Term Deposit Lookups
Options
optns
GET All Term Deposit Interest Rates
get
Options
optns
GET All Term Deposit Account Types
get
Options
optns
GET All Dated Details For an Account Type.
get
Options
optns
GET All Term Deposit Account Types Parameters For Specified Details.
get
Options
optns
GET default values of the specified Term Deposit Account Type and Effective Date.
get
Options
optns
Get Term Deposits Company default values
get
Options
optns
GET All Term Deposit Types
get
Options
optns
Get Rate Increment Codes.
get
Options
optns
GET All Term Deposit CDIC Account Types
get
Options
optns
GET All Term Deposit Compound Frequencies
get
Options
optns
GET All Interest Calculation Methods
get
Options
optns
GET All Interest Calculation Types
get
Options
optns
GET All Term Deposit Investment Types
get
Options
optns
GET All Term Deposit Ownership types
get
Options
optns
GET All Payment Disposition Codes
get
Options
optns
GET All Term Deposit Payment Frequencies
get
Options
optns
GET All Pay Modes
get
Options
optns
GET All Term Deposit Principal Exceptions
get
Options
optns
GET All Term Deposit Investment Purchase Codes and Descriptions
get
Options
optns
GET All Term Deposit Rate Exceptions
get
Options
optns
GET All Related Clients Relationship Types
get
Options
optns
GET All Term Deposit Status Values
get
Portfolio+ Lending Management API
Lending Search
Options
optns
GET Generic Lending Account Search
get
Create a lending application
post
Options
optns
GET Lending Account Details
get
Update Lending Account - Not currently implemented
put
Partial update of a given lending account.
patch
Options
optns
GET Lending Account Balances
get
HELOC Account Details
Options
optns
GET Specific HELOC Account Details
get
Hypothetical Amortization
Options
optns
Create Hypothetical Amortization
post
Lending Affiliates and Related Clients
Options
optns
GET All Affiliates
get
Create Affiliate
post
Options
optns
GET All Affiliates By Type
get
Options
optns
GET A Specific Affiliate
get
Update Specific Affiliate
patch
Remove an Affiliate
delete
Options
optns
GET All Connected Relationships
get
Create Connected Relationship
post
Options
optns
GET Specific Connected Relationship
get
Update Specific Connected Relationship
patch
Remove a Connected Relationship
delete
Lending Amortization
Options
optns
GET Amortization Schedule
get
Lending Applicants
Options
optns
GET All Applicants
get
Create co-applicants and guarantors
post
Options
optns
GET All Applicants By Type
get
Options
optns
GET A Specific Applicant
get
Partial update of applicant
patch
Remove a CoApplicant or Guarantor
delete
Options - To be implemented
optns
GET A Specific Power of Attorney - To be implemented
get
To be implemented
patch
To be implemented
delete
Lending Arrears and Interest Due Details
Options
optns
GET Specific Arrears and Interest Due Details
get
Lending Calculations
Options
optns
GET Maturity Date
get
Options
optns
GET Maturity Date
get
Options
optns
Calculate Principal and Interest
post
Lending Charge Details
Options
optns
GET Other Lender Details
get
UPDATE Other Lender
patch
Lending Checklists
Options
optns
GET Checklist Items
get
Create Checklist Items
post
Options
optns
GET Checklist Items By Type
get
Options
optns
GET Specific Checklist Item
get
Update Checklist Items
patch
Delete Checklist Item
delete
Lending Comments
Options
optns
GET All Lending Account Comments
get
Create Lending Account Comment
post
Options
optns
GET Specific Lending Account Comment
get
Update Lending Account Comments
put
Lending Custom Attributes
Options
optns
Get all Custom Attributes for a Lending account.
get
Attach a Custom Attribute to a Lending account.
post
Options
optns
Get a specific Custom Attribute for a Lending account.
get
Update a specific Custom Attribute for a Lending account.
patch
Delete a specific Custom Attribute link for a Lending account.
delete
Lending Dates
Options
optns
GET All Lending Account Dates
get
Lending Distribution of Funds
Options
optns
GET Distribution of Funds
get
Lending Fees
Options
optns
GET All Default Fees
get
Update Fees
patch
Lending Interest Rates
Options
optns
GET Current Interest Rates
get
Get the default interest rate
post
Lending Letter of Credit Information
Options - Currently Not Implemented
optns
GET Letter Of Credit Information - Currently Not Implemented
get
Update Letter Of Credit Information - Currently Not Implemented
put
Lending Mortgage Insurance
Options
optns
GET Mortgage Insurance details
get
UPDATE Mortgage Insurance details
patch
Lending Other Charges
Options
optns
GET All Other Charges
get
Create Lending Account Other Charge
post
Options
optns
GET specified Other Charge
get
Update Lending Account Other Charge
patch
Delete existing Other Charge
delete
Lending Payment Adjustment
Options
optns
GET Payment Adjustment
get
Update Payment Adjustment
put
Create Payment Adjustment
post
Delete Existing Payment Adjustment
delete
Lending Payment Date Change
Options
optns
To be implemented
post
Lending Payment Deferral
Options
optns
To be implemented
post
Lending Payment Frequency Change
Options
optns
To be implemented
post
Lending Payment Split
Options
optns
GET Regular Payment Components
get
Lending Payments
Options
optns
GET Payment History
get
Create Payment
post
Options
optns
GET Specific Payment Details
get
Reverse Payment
post
Options
optns
Get Variable Payment Schedule
get
Lending PayMode Details
Options
optns
GET Specific PayMode Details
get
Update PayMode Details
put
Lending Rates
Options
optns
GET All Lending Account Rates
get
Lending Ratios
Options
optns
GET All Ratios
get
Lending Responsibilities
Options
optns
GET Responsibilities
get
UPDATE Responsibilities
patch
Lending Securities
Options
optns
GET All Lending Account Securities
get
CREATE Lending Account Security
post
Options
optns
GET specific Lending Account Security
get
DELETE specific Lending Account Security
delete
Options
optns
Get all appraisals for the specified account security.
get
Create a new Lending Account Security appraisal
post
Options
optns
Get one specific appraisal for the specified account security.
get
Update one specific appraisal for the specified account security.
patch
Delete a Lending Account Security appraisal record
delete
Options
optns
Get Lending Security Building
get
UPDATE Lending Security Building
patch
Options
optns
Get Lending Security Condominium
get
UPDATE Lending Security Condo
patch
Options
optns
GET All Security Encumbrances
get
To be implemented
post
Options
optns
GET Specific Security Encumbrance
get
UPDATE Specific Security Encumbrance
patch
To be implemented
delete
Options
optns
To be implemented
get
To be implemented
put
To be implemented
delete
Options
optns
To be implemented
get
To be implemented
patch
Options
optns
Get Lending Security Information
get
UPDATE Lending Security Information
patch
Options
optns
Get municipal details on a PROP security type.
get
UPDATE Lending Security Municipal
patch
Options
optns
To be implemented
get
To be implemented
post
Options
optns
To be implemented
get
To be implemented
patch
To be implemented
delete
Options
optns
GET All Security Tax Payments
get
To be implemented
post
Options
optns
GET Specific Security Tax Payment
get
UPDATE Specific Security Tax Payment
patch
To be implemented
delete
Lending Statements
Options
optns
Query statements for a given lending account.
get
Options
optns
Query specific statement document
get
Lending Syndication
Options
optns
Query Partners and Investors for a given lending account.
get
Options
optns
GET a specific Loan Partner or Investor.
get
Lending Lookups
/System/Lending/AccountStatementTypes
optns
Query lending account statement types.
get
Options
optns
GET All Affiliates
get
Options
optns
GET Appraisal Types
get
Options - Currently Not Implemented
optns
GET Building Attribute Values - Currently Not Implemented
get
Options
optns
GET Building BasementType
get
Options
optns
GET Building BuildingCodes
get
Options - Currently Not Implemented
optns
GET Property Building Construction Types - Currently Not Implemented
get
Options
optns
GET GarageSize
get
Options
optns
GET Building Garage Type
get
Options
optns
GET Building Heating Type
get
Options
optns
GET SewerType
get
Options
optns
GET building water supply
get
Options
optns
GET No Re-advance Reasons
get
Options
optns
GET Lending Charge Registrants
get
Options
optns
Query Closing Service Codes.
get
Options - Currently Not Implemented
optns
GET All Comments Categories - Currently Not Implemented
get
Options
optns
GET Charge Types
get
Options
optns
GET All Default Lender fee
get
Options
optns
Retrieves a Company's lending default values.
get
Options
optns
GET Lending External Lenders
get
Options
optns
GET All Product Lines
get
Options
optns
GET All Product Types
get
Options
optns
GET A Specific Product Type
get
Options
optns
GET A Specific Product Type Defaults
get
Options
optns
GET A Specific Product Type Default Fees
get
Options - Currently Not Implemented
optns
GET Product Type GL Transaction Types - Currently Not Implemented
get
Options
optns
GET A Specific Product Type Requirements
get
Options
optns
GET All Risks
get
Options
optns
GET All Sources
get
Options
optns
GET All Compound Frequencies
get
Options
optns
GET All Custom Attributes
get
Options
optns
GET all Custom Attribute Codes by Custom Attribute
get
Options
optns
GET All Custom Attribute Rules
get
Options
optns
GET All Custom Attribute Rule Details
get
Options
optns
GET Lending Details Applicant Types
get
Options - Currently Not Implemented
optns
GET Exception Levels - Currently Not Implemented
get
Options - Currently Not Implemented
optns
GET Exception Materialities - Currently Not Implemented
get
Options - Currently Not Implemented
optns
GET Exception Types - Currently Not Implemented
get
Options - Currently Not Implemented
optns
GET Fee Types - Currently Not Implemented
get
Options
optns
GET Lending GDS TDS Ratio Codes
get
Options
optns
GET Lending Insurer
get
Options
optns
GET All Lending Insurer programs.
get
Options
optns
GET All Lending Interest Adjustment Methods
get
Options
optns
GET All Interest Methods
get
Options
optns
GET Lending Areas
get
Options
optns
GET All Lending Classes
get
Options
optns
GET All Lending Reasons
get
Options
optns
GET All Lending Status
get
Options
optns
GET LendingTypes
get
Options
optns
GET All Payment Plans
get
Options
optns
GET Pay Modes
get
Options
optns
GET All Prepayment Penalty Types
get
Options - Currently Not Implemented
optns
GET Power of Attorney Types - Currently Not Implemented
get
Options
optns
GET All Lending Program Types
get
Options
optns
GET All Progress Advance Types
get
Options
optns
GET all Pricing Promo Codes
get
Options - Currently Not Implemented
optns
GET Property Discharge Status - Currently Not Implemented
get
Options
optns
GET Property Dwelling Style Codes
get
Options
optns
GET Property Dwelling Types
get
Options
optns
GET Property List Types
get
Options
optns
GET Property Municipal Codes
get
Options
optns
GET Property Municipal Tax Authorities
get
Options For a Specific tax authority code
optns
GET Property Municipal Tax Authority Detail
get
Options
optns
GET Property Municipal Zoning Codes
get
Options
optns
GET Property Occupancy Codes
get
Options
optns
GET Property Source Of Down Payment Types
get
Options
optns
GET Property Tenure Codes
get
Options
optns
GET Property Municipal Units of Measure
get
Options
optns
GET All Purposes
get
Options
optns
Query lending rate exceptions.
get
Options
optns
GET all Refinance Reasons
get
Options
optns
GET Lending Registered Charge Types
get
Options
optns
GET Lending Sectors
get
Options
optns
GET Security Classes
get
Options - Currently Not Implemented
optns
GET Account Insurance Status - Currently Not Implemented
get
Options
optns
GET Security Type Details
get
Options
optns
GET Security Types
get
Options
optns
GET Lending Servicers
get
Options
optns
GET Taxes Paid By Codes
get
Options
optns
GET Lending Valuation Status
get
Options
optns
GET All Payment Frequencies
get
Options
optns
GET Prepayment Privileges
get
Portfolio+ Investments API
Investments Search
Options
optns
GET Generic Investment Search
get
Options
optns
GET Generic Investment Search By Company
get
Options
optns
GET Investment Details
get
Investments Cash Transactions
Options
optns
GET Investment Cash Transactions
get
Investments Checklists
Options
optns
GET Checklist Items
get
Options
optns
GET Checklist Items By Type
get
Options
optns
GET Specific Checklist Item
get
Investments Contributions
Options
optns
GET Contributions Amounts
get
Investments Holdings
Options
optns
GET Investment Holdings
get
Options
optns
GET Specific Investment Holding
get
Investments Notes
Options
optns
GET All Notes For An Investment Plan
get
Options
optns
GET Specific Note
get
Investments Payments
Options
optns
GET All Investment Payments
get
Options
optns
GET A Specific Payment
get
Investments RESP Beneficiary
Options
optns
GET RESP Beneficiary Details
get
Investments RESP Notional Values
Options
optns
GET RESP Notional Values
get
Investments Related Clients and Agents
Options
optns
GET Investment Related Clients
get
Options
optns
GET Investments Related Clients by Client Number
get
Options
optns
GET Investment Agents
get
Options
optns
GET Investment Agent Details
get
Investments Scheduled Transactions
Options
optns
GET Investment Scheduled Transactions
get
Investments Trades
Options
optns
GET All Trades
get
Investments Transactions
Options
optns
GET Investment Transactions
get
Investments Valuation
Options
optns
GET Investment Plan Valuation
get
Investments Lookups
Options
optns
GET All Academic Codes
get
Options
optns
GET All Asset Classes
get
Options
optns
GET All Asset Transaction Codes
get
Options
optns
GET All Asset Transaction Codes
get
Options
optns
GET All Cash Account Types
get
Options
optns
Retrieves a Company's investments default values.
get
Options
optns
GET All Fee Codes
get
Options
optns
GET Investment Fee Code Details
get
Options
optns
GET All Plan Transaction Cheque Status
get
Options
optns
Get Investment Contribution Limits
get
Options
optns
GET All Educational Institutions
get
Options
optns
GET All Educational Programs
get
Options
optns
Get Exchanges
get
Options
optns
GET All Fee Frequencies.
get
Options
optns
GET All Investments Fee Modes Options
get
Options
optns
GET All Investments Holding Status Types
get
Options
optns
GET All Market Identifiers
get
Options
optns
GET All Market Identifiers for Plan Type
get
Options
optns
GET All Market Identifiers for Plan Group
get
Options - Not currently implemented
optns
GET All Investments Ownership Types - Not currently implemented
get
Options
optns
GET All Investments Payment Frequencies
get
Options
optns
GET All Investments Payment Options
get
Options
optns
GET All Investments Payment Tax Options
get
Options
optns
GET All Plan Asset Types
get
Options
optns
GET All Plan Groups
get
Options
optns
GET All Plan Groups
get
Options
optns
GET All Plan Types
get
Options
optns
GET Plan Type Details
get
Options
optns
GET All Investment Plan Status Types
get
Options
optns
GET All Investments Related Clients Relationship Types
get
Options
optns
GET All Investments Rule Base
get
Options
optns
GET All Plan Scheduled Transaction Statuses
get
Options
optns
GET All Security Types
get
Options
optns
GET All Investments Statement Payment Frequencies
get
Options
optns
GET All Trade Pending Values
get
Portfolio+ Client Management API
Client Search
Options
optns
GET Client Profile Information
get
Create Client Profile
post
Options
optns
GET Specific Client Profile
get
Update Specific Profile
put
Update Specific Profile
patch
Client Access Management
Options
optns
GET GUID Web Info
get
Options
optns
GET a One-Time Password
get
Validate a One-Time Password
post
Options
optns
Update Password
post
Step 1 - Options
optns
Step 1 - Initiate Password Reset
post
Step 2 - Options
optns
Step 2 - Query Challenge Question
get
Step 3 - Answer Challenge Question
post
Step 4 - Set New Password
patch
Client Addresses
Options
optns
GET All Addresses
get
Create Client Address
post
Options
optns
GET Specific Address
get
Create or Replace an address
put
Delete Address
delete
Client Alerts
Options
optns
Trigger Client Alert
post
Options
optns
GET Client Alerts
get
Update Client Alert
patch
Client Alternate Contacts
Options
optns
GET Alternate Contacts
get
Create Alternate Contact
post
Options
optns
GET Specific Alternate Contact
get
Update Client Alternate Contact
put
Delete Client Alternate Contact
delete
Client Assets
Options
optns
GET Assets For a Client
get
Create Client External Asset
post
Options
optns
GET Specific Client Asset
get
Update Client External Asset
put
Delete Client External Asset
delete
Client Checklists
Options
optns
GET All Checklists
get
Create Client Checklist Item
post
Options
optns
GET Checklist Type Item
get
Options
optns
GET Specific Checklist Item For a Client
get
Update Client Checklist Item
patch
Delete Client Checklist
delete
Client Communication and Marketing
Options - IRELAND ONLY
optns
GET Communication Modes - IRELAND ONLY
get
Update Communication Modes - IRELAND ONLY
patch
Options - IRELAND ONLY
optns
GET Client Marketing Information - IRELAND ONLY
get
Update Marketing Information - IRELAND ONLY
put
Client Contacts
Options
optns
GET Client Contact Information
get
Create Client Contact
post
Options
optns
GET Specific Client Contact
get
Update Existing Client Contact
put
Delete Client Contact Method
delete
Client Credit References
Options
optns
GET Credit References For A Client
get
Create Client Credit Reference
post
Options
optns
Not currently implemented
post
Options
optns
GET A Specific Credit Reference
get
Update Specific Credit Reference
put
Remove A Credit Reference
delete
Client External Id
Options
optns
GET Client Number by External ID Type and ID Number
get
Options
optns
GET External Id by Client Number
get
Create New External ID
post
Options
optns
GET External Id by IdType
get
Options
optns
GET Specific External Id by Sequence Number
get
Update Specific External Id by Sequence Number
patch
Delete Specific External Id by Sequence Number
delete
Client External Institution
Options
optns
GET All Client External Institutions
get
Create Client External Institution
post
Options
optns
GET Specific Client External Institution
get
Update Client External Institution
put
Delete Client External Institution
delete
Client Image
Options for Client Image
optns
GET Client Image
get
Update Client Image
put
Client Incomes
Options
optns
GET All Incomes For Client
get
Create Client Income
post
Options
optns
GET Specific Income
get
Update Existing Client Income
put
Delete Client Income
delete
Client Liabilities
Options
optns
GET Client Liabilities
get
Create Client External Liability
post
Options
optns
GET a Specific External Client Liability
get
Update Client External Liability
put
Delete Client External Liability
delete
Client Next of Kin
Options
optns
GET All Next of Kin For a Client
get
Create Next of Kin
post
Options
optns
GET Specific Next of Kin For a Client
get
Update Next of Kin
patch
Delete Next of Kin
delete
Client Notes
Options
optns
GET All Notes For a Client
get
Create Client Note
post
Client Payees
Options
optns
GET Client Payee List
get
Create Bill Payee
post
Options
optns
GET Specific Client Payee
get
Update Client Bill Payee
patch
Delete Bill Payee
delete
Client Regulatory
Options
optns
GET Client Regulatory Information
get
Update Client Regulatory Information
put
Update Client Regulatory Information
patch
Options
optns
GET All Client CRSReportable records
get
Add a Client CRSReportable
post
Options
optns
GET Specific CRSReportable
get
Update a Client CRSReportable
patch
Delete Client CRSReportable
delete
Client Residencies
Options
optns
GET All Client Residency records
get
Add a Client Residency
post
Options
optns
GET Specific Residency
get
Update a Client Residency
patch
Delete Client Residency
delete
Client Security Questions
Options
optns
GET All Security Questions
get
Create Security Question
post
Options
optns
GET Specific Security Question
get
Update Client Security Question
patch
Delete Client Security Question
delete
Options
optns
GET Random Security Question
get
Validate Security Question Response
post
Firm Underlying Owners
Options
optns
GET All Underlying Owners
get
Create Firm Underlying Owner
post
Options
optns
GET Specific Underlying Owner
get
Update Firm Underlying Owner
put
Delete Firm Underlying Owner
delete
Client Management Lookups
Options
optns
GET All Address Types
get
Options
optns
GET AML Client Categories
get
Options
optns
GET All Asset Types
get
Options
optns
GET Client Types
get
Options
optns
GET All Communication Types
get
Options
optns
GET Client Credit Reference Rating Codes
get
Options
optns
GET All Credit Reference Types
get
Options
optns
GET CRS Reason Codes
get
Options
optns
GET All External ID Type Codes and Descriptions
get
Options
optns
GET All Genders
get
Options
optns
GET All Income Types
get
Options
optns
GET All Income Verification Types
get
Options
optns
GET All Industry Sectors
get
Options
optns
GET All Liability Types
get
Options
optns
GET All Marital Statuses
get
Options - IRELAND ONLY
optns
GET All Marketing Material Types - IRELAND ONLY
get
Options - IRELAND ONLY
optns
GET All Market Research Types - IRELAND ONLY
get
Options
optns
GET NAICS Codes
get
Options
optns
GET All Occupancy Types
get
Options
optns
GET All Occupations
get
Options - Currently Not Implemented
optns
GET Third Party Client Types - Currently Not Implemented
get
Options
optns
GET All Titles
get
Options
optns
Get all Firm Underlying Owner Type Codes and Descriptions
get
Portfolio+ Agent Management API
Agent Contacts
Options
optns
GET Agent Contacts
get
Create Agent Contact
post
Options
optns
GET Specific Agent Contact
get
Update Specific Agent Contact
patch
Delete Specific Agent Contact
delete
Agent Profiles
Options
optns
GET Agent Profiles
get
Create Agent Profile
post
Options
optns
GET Specific Agent Profile
get
Update Specific Agent Profile
patch
Delete Specific Agent Profile
delete
Options
optns
GET Agent PayMode Details
get
Commission and Authorization
Options - Not currently implemented
optns
GET Commission and Authorization - Not currently implemented
get
Create Commission and Authorization - Not currently implemented
post
Options - Not currently implemented
optns
GET Specific Commission and Authorization - Not currently implemented
get
Update Specific Commission and Authorization - Not currently implemented
patch
Delete Specific Commission and Authorization - Not currently implemented
delete
Agent Management Lookups
Options
optns
GET Agent Types
get
Options - Not currently implemented
optns
GET Agent Broker Types - Not currently implemented
get
Options
optns
GET Distribution Channels
get
Options Agent Net Settlement Types
optns
GET Agent Net Settlement Types
get
Portfolio+ System Administration API
AML Management
Options
optns
GET All Term Deposit AML/ATF Risk types.
get
Options
optns
GET AML Categories
get
Options
optns
GET AML Q&A
get
Options
optns
GET Specific AML Question
get
Checklist Types
Options
optns
GET Client Checklists Types
get
Options
optns
GET Checklists Types
get
Options
optns
GET Client Checklist Default Texts
get
Options
optns
GET Checklist Default Texts
get
Client Applications
Options
optns
Reset Client Secret
post
Currencies
Options - Not currently implemented
optns
GET Currencies - Not currently implemented
get
Currency Exchange
Options
optns
Query Currency Exchange Data
post
Document Management
Options
optns
Search Documents
post
Options
optns
Document Management
get
Error Messages
Options
optns
Get all Error Messages.
get
System Date Validation
Options
optns
GET Valid Business Date
get
System Generated Keys
Options
optns
Create Generated Key
post
System Passwords
Options
optns
GET Password Rules
get
Update Password Rules
put
System Admin Lookups
Options
optns
GET All Address Unit Types
get
Options
optns
GET All Affiliate Types
get
Options
optns
GET System Alerts
get
Options
optns
GET System Alert Detail
get
Options
optns
GET Base Rate Codes
get
Options
optns
GET All Companies
get
Options
optns
GET Company Details
get
Options
optns
GET Bank Account Details
get
Options
optns
Query branch details
get
Options
optns
Query prime and base rates
get
Options
optns
GET Intended Use Details
get
Options
optns
GET Communication Types
get
Options
optns
GET Communication Type Detail
get
Options
optns
GET Lines Of Business
get
Options
optns
GET All Counties
get
Options
optns
GET All Countries
get
Options
optns
GET All Category Codes
get
Options
optns
GET Document Types
get
Options
optns
GET All Employees
get
Options
optns
GET Specific Employee
get
Options
optns
GET Financial Institutions
get
Options
optns
GET External Institution Detail
get
Options
optns
GET Financial Institution Branches
get
Options
optns
GET External Institution Branch Detail
get
Options
optns
GET All Languages
get
Options
optns
GET All Low Balance Opt-Out Reasons.
get
Options
optns
GET Other Affiliate Types
get
Options
optns
GET All Other Agent Types
get
Options
optns
GET All Provinces
get
Options - Not currently implemented
optns
GET Regulatory Codes - Not currently implemented
get
Options
optns
GET All Relationships
get
Options
optns
GET Security Questions
get
Options
optns
GET All Sub Systems
get
Options
optns
GET Roles
get
Options
optns
GET All Users
get
Options
optns
GET Specific User
get
Role Management
Options
optns
GET Entity Roles
get
Options
optns
Assign Role
put
Revoke Role
delete
Powered by
Options
optns
https://example.com/client/web/Clients/
{ClientNumber}
/Alerts
Options For Alerts
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Authenticate
Bearer
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!
