Accounts¶

All requests require clientID and developerAPIKey parameters for authentication.

Base URL: https://api-sandboxdash.norcapsecurities.com

Endpoints¶

GET /v3/accounts
POST /v3/addAccountNote
PUT /v3/calculateSuitability
PUT /v3/createAccount
POST /v3/deleteAccount
POST /v3/deleteAccountDocument
POST /v3/deleteSuitability
POST /v3/getAccount
POST /v3/getAccountDocument
POST /v3/getAccountNotes
POST /v3/getAllAccounts
POST /v3/getSuitability
POST /v3/searchAccount
PUT /v3/updateSuitability
PUT /v3/updateAccount
POST /v3/updateAccountArchiveStatus

`GET /v3/accounts`¶

Fetch a list of account resources associated with this client. Accounts are ordered by created date with the most recently created account at index zero.

Permissions¶

This method requires the scope account.read.pii_high to be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal. A PII high scope is required because responses contain sensitive information like names, addresses, tax identification numbers, and information about investor eligibility.

Authorization¶

Header: Authorization: Bearer clientId:apiKey

Query Parameters¶

Parameter	Type	Default	Description
`offset`	integer	0	The row index at which to begin the query. Zero represents the first account in the list.
`limit`	integer	10	The maximum number of accounts to return. Max value is 500.
`deleted`	boolean	false	Include deleted accounts in response.
`filter`	string (JSON)		Filter results by specific fields.

Filtering¶

Filters limit the values included in responses to those defined. Filters only support full equality. Expressions and inequalities are not supported at this time. All filters are ANDed together, meaning a record must match all filters to be included in the response.

/v3/accounts?filter={"type":"Individual", "state":"AL"}
/v3/accounts?filter[type]=Individual&filter[state]=AL

This also allows for filtering lists. Lists are inclusive in a this-or-that relationship, meaning records that match any value in the list will be included in the result.

/v3/accounts?filter={"state": ["AL", "WY"], "type": "Individual"}
/v3/accounts?filter[state]=AL&filter[state]=WY&filter[type]=Individual

For more information on filtering see Working with List Endpoints.

`POST /v3/addAccountNote`¶

This is how you add notes to a specific account

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API once an account is created (createAccount)
`authorName`	string	Yes	Author Name
`notes`	string	Yes	Notes

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/addAccountNote
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d authorName=authorName
-d notes=notes
-d accountId=123456

Response¶

Field	Type	Description
`notesDetails`	string	Array of account notes includes all information of the matched account

`PUT /v3/calculateSuitability`¶

This method is used to add investment suitability information to an account (createAccount).

Parameters¶

Parameter	Type	Required	Description
`accountId`	integer	Yes	Account ID that is generated by the API once an account is created (createAccount)
`riskProfile`	conditional	No	Risk Profile Score: 1,2,3,4,5 (1=very conservative; 5=very aggressive)
`investmentExperience`	conditional	No	Investment Experience Score: 1,2,3,4,5 (1=none; 5=extensive)
`privOffExperience`	conditional	No	Experience Investing in Private Offerings Score: 1,2,3,4,5 (1=none; 5=extensive)
`pctPrivSecurities`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Private Placements
`pctIlliquidSecurities`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Illiquid Securities
`pctLiquidSecurities`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Liquid Securities
`pctRealEstate`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Real Estate
`timeHorizon`	conditional	No	The number of years until the investment portfolio is expected to reach maturity
`education`	conditional	No	Investor's Highest level of education: High School or GED, 4 Year College or University, Graduate Degree, Other
`financialAdvisor`	string	No	Does the Investor have a financial advisor? Yes or No
`notes`	string	No	Free form text for any notes that need to be added for the suitability
`investmentObjective`	string	No	Primarily on Capital Preservation, Both Capital Preservation and Growth, Primarily Focused on growth
`additionalnotes`	string	No	Free form text for any notes that need to be added for the suitability

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/calculateSuitability
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A43256
-d riskProfile=1
-d investmentExperience=1
-d investmentObjective=Both Capital Preservation and Growth
-d privOffExperience=1
-d pctPrivSecurities=5
-d pctIlliquidSecurities=4
-d pctLiquidSecurities=4
-d pctRealEstate=6
-d timeHorizon=4
-d education=High School or GED
-d financialAdvisor=yes
-d notes=Suitability for an account
-d additionalnotes=Suitability for an account

Response¶

Field	Type	Description
`accountId`	integer	Unique Identifier code for the account

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": [
    {
      "accountId": "A43256"
    }
  ]
}

`PUT /v3/createAccount`¶

This method is used to create an account that can be linked (createLink) to an individual party (createParty) or an entity (createEntity).

Parameters¶

Parameter	Type	Required	Description
`accountRegistration`	string	Yes	Investor Account Name. Must be the exact registration of the account, such as "John Doe and Jane Doe JTWROS" or "John Doe IRA" or "Doe Family Trust"
`type`	conditional	Yes	Type of Account: Individual, Entity, TIC, JTWROS, IRA, SepIRA, ROTH,Joint
`entityType`	conditional	No	Type of Entity: Revocable Trust, Irrevocable Trust, Limited Partnership, LLC, Corporation
`domesticYN`	conditional	Yes	Domestic or International Account - "domestic_account" or "international_account"
`streetAddress1`	string	Yes	Account Street Address Line 1
`streetAddress2`	string	No	Account Street Address Line 2
`city`	string	Yes	Account City
`state`	string	Yes	The state in which the account holders primary residence (or physical address) is located (must use abbreviated 2 letter form). Use the value “NOUS” for addresses outside the United States.
`zip`	string	Yes	Account Zip/Postal Code
`country`	string	Yes	Account Country
`email`	string	No	Account Primary Email Address
`phone`	integer	No	Account Primary Phone Number
`taxID`	integer	No	Account Tax ID Number
`KYCstatus`	conditional	Yes	Know Your Customer(KYC) Status: Pending, Auto Approved, Manually Approved, Disapproved. The default status is "Pending"
`AMLstatus`	conditional	Yes	Anti-Money Laundering (AML) Status: Pending, Auto Approved, Manually Approved, Disapproved. The default status is "Pending"
`AMLdate`	date	No	Date that the Anti-Money Laundering (AML) status was updated from the default "Pending" status.
`suitabilityScore`	integer	No	Score from 1 to 5. 5 being most suitable and 1 being least suitable
`suitabilityDate`	date	No	Date that a Registered Representative (RR) approved the suitability for the account.
`suitabilityApprover`	string	No	The name of the Registered Representative (RR) that approved the suitability for the account.
`AccreditedStatus`	conditional	Yes	The Accreditation Status for the Account: Pending, Self Accredited, Verified Accredited, Not Accredited. The default status is "Pending"
`Allow`	conditional	No	How the account was accredited: Income, Assets, All parties accredited, Pending
`AIdate`	date	No	The date that the most recent accreditation review will expire.
`506cLimit`	integer	No	The maximum total dollar amount that can be invested in Regulation D 506(c) offerings by this account
`accountTotalLimit`	integer	No	The maximum total amount that can be invested from this account
`singleInvestmentLimit`	integer	No	The maximum amount that can be invested in a single investment for the account
`associatedAC`	conditional	No	Yes or No. Generally completed in the Admin interface following a discussion with the Investor
`syndicate`	conditional	No	Yes or No. Generally completed in the Admin interface following a discussion with the Investor
`tags`	string	No	Up to 10 tags can be added to an account separated by commas. These are generally completed in the TAPI Admin interface or with question-based tag generation
`notes`	string	No	Free form text for any notes that need to be added to the account
`approvalStatus`	conditional	Yes	Principal Approval Status: Pending, Approved, Not Approved
`approvalPrincipal`	string	No	Name of Principal Reviewing the Account
`approvalLastReview`	date	No	Date of previous accreditation review
`field1`	string	No	Additional information relating to the account. Custom Field 1
`field2`	string	No	Additional information relating to the account. Custom Field 2
`field3`	string	No	Additional information relating to the account. Custom Field 3

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/createAccount
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d accountRegistration=John
 -d type=Individual
 -d entityType=Revocable Trust
 -d domesticYN=domestic account
 -d streetAddress1=First street
 -d streetAddress2=Third avenue
 -d city=ATLANTA
 -d state=GA
 -d zip=32526
 -d country=USA
 -d phone=41545218562
 -d taxID=875451545875855
 -d KYCstatus=pending
 -d AMLstatus=pending
 -d suitabilityScore=5
 -d suitabilityDate=02-18-2016
 -d suitabilityApprover=smith
 -d AccreditedStatus=pending
 -d AIlow=income
 -d AIdate=02-18-2016
 -d 506cLimit=50000
 -d accountTotalLimit=200000
 -d singleInvestmentLimit=100
 -d associatedAC=yes
 -d syndicate=no
 -d tags=terms
 -d notes=Personal Account
 -d approvalStatus=pending
 -d approvalPrincipal=Charles
 -d approvalLastReview=02-15-2016
 -d field1=some text
 -d field2=some text
 -d field3=some text

Response¶

Field	Type	Description
`accountDetails`	string[]	See below for details

Field	Type	Description
`accountId`	string	Account ID that is generated by the API once an account is created (createAccount).
`kycStatus`	string	Know Your Customer(KYC) Status: Pending, Auto Approved, Manually Approved, Disapproved. The default status is "Pending"
`amlStatus`	string	Anti-Money Laundering (AML) Status: Pending, Auto Approved, Manually Approved, Disapproved. The default status is "Pending"
`accreditedStatus`	string	The Accreditation Status for the Account: Pending, Self Accredited, Verified Accredited, Not Accredited. The default status is "Pending"
`approvalStatus`	string	Principal Approval Status: Pending, Approved, Not Approved

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": [
    {
      "accountId": "A2652697",
      "kycStatus": "Pending",
      "amlStatus": "Pending",
      "accreditedStatus": "Pending",
      "approvalStatus": "Approved"
    }
  ]
}

`POST /v3/deleteAccount`¶

This method is used to delete an account that is created for an individual party or entity party.

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API when an account is created(createAccount)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deleteAccount
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d accountId=A34554

Response¶

Field	Type	Description
`accountDetails`	string	Success Message

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": "Account deleted successfully!"
}

`POST /v3/deleteAccountDocument`¶

This method is used to delete the account document upload.

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API once an individual account is created (createAccount)
`documentId`	string	Yes	Document Id generated in the time of upload account document API method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deleteAccountDocument
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A27512
-d documentId=SDrKb

Response¶

Field	Type	Description
`document\_details`	string	Document deleted successfully

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": "Document deleted successfully"
}

`POST /v3/deleteSuitability`¶

This method is used to delete investment suitability for an account(createAccount).

Parameters¶

Parameter	Type	Required	Description
`accountId`	integer	Yes	Account ID that is generated by the API once an account is created (createAccount)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deleteSuitability
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A23454

Response¶

Field	Type	Description
`accountDetails`	string	Success Message

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": "Account deleted successfully!"
}

`POST /v3/getAccount`¶

Deprecated

This endpoint is deprecated and may be removed in a future version.

This method is used to get all information for an account (createAccount).

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API once an account is created (createAccount).

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAccount
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d accountId=A77654

Response¶

Field	Type	Description
`accountDetails`	string	Array of account information (all information of the matched account)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": {
    "accountId": "A77654",
    "accountName": "john",
    "type": "Individual",
    "entityType": "Revocable Trust",
    "residentType": "domestic account",
    "address1": "First street",
    "address2": "Fourth Avenue",
    "city": "ATLANTA",
    "state": "GA",
    "zip": "43543",
    "country": "USA",
    "phone": "4152323232",
    "taxID": "43543543",
    "kycStatus": "Pending",
    "kycDate": "2016-02-23 13:29:30",
    "amlStatus": "Pending",
    "amlDate": "2016-02-23 13:29:30",
    "suitabilityScore": "5",
    "suitabilityDate": "2016-02-23 13:29:30",
    "suitabilityApprover": "Smith",
    "accreditedStatus": "Pending",
    "accreditedInvestor": "income",
    "accreditedInvestorDate": "02-02-2016",
    "506cLimit": "50000",
    "accountTotalLimit": "1000000",
    "singleInvestmentLimit": "1000",
    "associatedAC": "yes",
    "syndicate": "yes",
    "tags": "real estate",
    "notes": "Offers",
    "approvalStatus": "Pending",
    "approvalPrincipal": "Charles",
    "approvalLastReview": "12-02-2016",
    "archived_status": "0",
    "field1": "Account Field 1",
    "field2": "Account Field 2",
    "field3": "Account Field 3"
  }
}

`POST /v3/getAccountDocument`¶

This method is used to retrieve the information for all documents (uploadAccountDocument) that are associated with a particular account.

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API once an account is created (createAccount)
`documentId`	string	No	Document Id generated in the time of upload party document API method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAccountDocument
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A90251
-d documentId=SDrKb

Response¶

Field	Type	Description
`document\_details`	string	Array of account document details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": [
    {
      "accountid": "A90251",
      "documentid": "Mvz1B",
      "documentTitle": " Test",
      "documentFileName": "GKrQ081118064622.pdf",
      "documentFileReferenceCode": "081118064622",
      "createdDate": "2018-11-08",
      "documentUrl": "https://api-development.norcapsecurities.com/tapiv3/uploads/accounts/GKrQ081118064622.pdf"
    }
  ]
}

`POST /v3/getAccountNotes`¶

Deprecated

This endpoint is deprecated and may be removed in a future version.

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API once an account is created (createAccount)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAccountNotes
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d accountId=A12345

Response¶

Field	Type	Description
`notesDetails`	string	Returns the account notes details as an array

Example Response¶

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "notesDetails": [
        {
         "developerAPIKey": "MyG0RJZUhdP7wkZXi5NvSCV47OjYGvkg3I7",
         "authorname": "jhon",
         "note": "test",
         "accountId": "A35513",
         "createdDate": "09-10-2019",
         "createdIP": "null",
        }
   ]
}

`POST /v3/getAllAccounts`¶

Deprecated

This endpoint is deprecated and may be removed in a future version.

Pulls all accounts for the client. NOTICE this endpoint will return a maximum of 500 results starting January 13. Please migrate to /v3/accounts which supports pagination and filtering.

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAllAccounts
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey

Response¶

Field	Type	Description
`accountDetails`	string	Get account details Array

Example Response¶

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "accountDetails":someArray
}

`POST /v3/getSuitability`¶

This method is used to retrieve all suitability information for a specific account. The AccountID is required as a request parameter for this method.

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API once an account is created (createAccount)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getSuitability
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A77654

Response¶

Field	Type	Description
`accountDetails`	string	Array of account includes all information of the matched accounts suitability details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": {
    "id": "92",
    "developerAPIKey": "2DttpCb9fhJHu3tMb9kiKvFIFfNZWCBiWdJ",
    "accountId": "A25454",
    "riskProfile": "1",
    "investmentObjective": "",
    "investmentExperience": "1",
    "privOffExperience": "1",
    "pctPrivSecurities": "12",
    "pctIlliquidSecurities": "12",
    "pctRealEstate": "12",
    "timeHorizon": "12",
    "education": "High School or GED",
    "financialAdvisor": "No",
    "notes": null,
    "virtualStatus": "ACTIVE",
    "createdDate": "2017-10-13 10:22:04",
    "updatedDate": null,
    "createdIpAddress": "159.203.134.7",
    "updatedIpAddress": null,
    "isdeleted": null
  }
}

`POST /v3/searchAccount`¶

Deprecated

This endpoint is deprecated and may be removed in a future version.

This method is used to search all accounts for a specific keyword within the account information.

Parameters¶

Parameter	Type	Required	Description
`searchKeyword`	string	Yes	Keyword to search within all accounts

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/searchAccount
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d searchKeyword=john

Response¶

Field	Type	Description
`accountDetails`	string	Array of account includes all information of the matched accounts

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": [
    {
      "accountId": "A34554",
      "accountName": "john",
      "type": "Individual",
      "entityType": "Revocable Trust",
      "residentType": "domestic account",
      "address1": "First street",
      "address2": "Fourth Avenue",
      "city": "ATLANTA",
      "state": "GA",
      "zip": "43543",
      "country": "USA",
      "phone": "4152323232",
      "taxID": "43543543",
      "kycStatus": "Pending",
      "kycDate": "2016-02-23 13:29:30",
      "amlStatus": "Pending",
      "amlDate": "2016-02-23 13:29:30",
      "suitabilityScore": "5",
      "suitabilityDate": "2016-02-23 13:29:30",
      "suitabilityApprover": "Smith",
      "accreditedStatus": "Pending",
      "accreditedInvestor": "income",
      "accreditedInvestorDate": "02-02-2016",
      "506cLimit": "50000",
      "accountTotalLimit": "1000000",
      "singleInvestmentLimit": "1000",
      "associatedAC": "yes",
      "syndicate": "yes",
      "tags": "real estate",
      "notes": "Offers",
      "approvalStatus": "Pending",
      "approvalPrincipal": "Charles",
      "approvalLastReview": "12-02-2016"
    }
  ]
}

`PUT /v3/updateSuitability`¶

This method is used to update investment suitability information for an account (createAccount)

Parameters¶

Parameter	Type	Required	Description
`accountId`	integer	Yes	Account ID that is generated by the API once an account is created(createAccount)
`riskProfile`	conditional	No	Risk Profile Score: 1,2,3,4,5 (1=very conservative; 5=very aggressive)
`investmentExperience`	conditional	No	Investment Experience Score: 1,2,3,4,5 (1=none; 5=extensive)
`privOffExperience`	conditional	No	Experience Investing in Private Offerings Score: 1,2,3,4,5 (1=none; 5=extensive)
`pctPrivSecurities`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Private Placements
`pctIlliquidSecurities`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Illiquid Securities
`pctLiquidSecurities`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Liquid Securities
`pctRealEstate`	integer	No	Percentage of the Investor's Investment Portfolio that is invested in Real Estate
`timeHorizon`	conditional	No	The number of years until the investment portfolio is expected to reach maturity
`education`	conditional	No	Investor's Highest level of education: High School or GED, 4 Year College or University, Graduate Degree, Other
`financialAdvisor`	string	No	Yes or No. Does the Investor have a financial advisor?
`notes`	string	No	Free form text for any notes that need to be added for the suitability
`invesmentObjective`	string	No	Primarily on Capital Preservation,Both Capital Preservation and Growth,Primarily Focused on growth
`additionalnotes`	string	No	Primarily on Capital Preservation,Both Capital Preservation and Growth,Primarily Focused on growth

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/updateSuitability
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A55473
-d riskProfile=1
-d investmentExperience=1
-d investmentObjective=Both Capital Preservation and Growth
-d privOffExperience=1
-d pctPrivSecurities=5
-d pctIlliquidSecurities=4
-d pctLiquidSecurities=4
-d pctRealEstate=6
-d timeHorizon=4
-d education=High School or GED
-d financialAdvisor=yes
-d notes=Suitability for an account
-d additionalnotes=Suitability for an account

Response¶

Field	Type	Description
`accountId`	string	Unique identifier code for the account

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": [
    {
      "accountId": "A55473"
    }
  ]
}

`PUT /v3/updateAccount`¶

This method is used to update a specific account (updateAccount)

Parameters¶

Parameter	Type	Required	Description
`accountId`	integer	Yes	Account ID that is generated by the API once an account is created (createAccount).
`accountRegistration`	string	Yes	Investor Account Name. Must be the exact registration of the account, such as "John Doe and Jane Doe JTWROS" or "John Doe IRA" or "Doe Family Trust"
`type`	conditional	Yes	Type of Account: Individual, Entity, TIC, JTWROS, IRA, SepIRA, ROTH, Joint
`entityType`	conditional	No	Type of Entity: Revocable Trust, Irrevocable Trust, Limited Partnership, LLC, Corporation
`domesticYN`	conditional	Yes	Domestic or International Account - "domestic_account" or "international_account"
`streetAddress1`	string	Yes	Account Street Address Line 1
`streetAddress2`	string	No	Account Street Address Line 2
`city`	string	Yes	Account City
`state`	string	Yes	The state in which the account holders primary residence (or physical address) is located (must use abbreviated 2 letter form). Use the value “NOUS” for addresses outside the United States.
`zip`	string	Yes	Account Zip/Postal Code
`country`	string	Yes	Account Country
`email`	string	No	Account Primary Email Address
`phone`	integer	No	Account Primary Phone Number
`taxID`	integer	No	Account Tax ID Number
`KYCstatus`	conditional	No	Know Your Customer(KYC) Status: Pending, Auto Approved, Manually Approved, Disapproved. The default status is "Pending"
`AMLstatus`	conditional	No	Anti-Money Laundering (AML) Status: Pending, Auto Approved, Manually Approved, Disapproved. The default status is "Pending"
`AMLdate`	date	No	Date that the Anti-Money Laundering (AML) status was updated from the default "Pending" status.
`suitabilityScore`	integer	No	Score from 1 to 5. 5 being most suitable and 1 being least suitable
`suitabilityDate`	date	No	Date that a Registered Representative (RR) approved the suitability for the account.
`suitabilityApprover`	string	No	The name of the Registered Representative (RR) that approved the suitability for the account.
`AccreditedStatus`	conditional	No	The Accreditation Status for the Account: Pending, Self Accredited, Verified Accredited, Not Accredited. The default status is "Pending"
`Allow`	conditional	No	How the account was accredited: Income, Assets, All parties accredited, Pending
`AIdate`	date	No	The date that the most recent accreditation review will expire.
`506cLimit`	integer	No	The maximum total dollar amount that can be invested in Regulation D 506(c) offerings by this account
`accountTotalLimit`	integer	No	The maximum total amount that can be invested from this account
`singleInvestmentLimit`	integer	No	The maximum amount that can be invested in a single investment for the account
`associatedAC`	conditional	No	Yes or No. Generally completed in the Admin interface following a discussion with the Investor
`syndicate`	conditional	No	Yes or No. Generally completed in the Admin interface following a discussion with the Investor
`tags`	string	No	Up to 10 tags can be added to an account separated by commas. These are generally completed in the TAPI Admin interface or with question-based tag generation
`notes`	string	No	Free form text for any notes that need to be added to the account
`approvalStatus`	conditional	Yes	Principal Approval Status: Pending, Approved, Not Approved
`approvalPrincipal`	string	No	Name of Principal Reviewing the Account
`approvalLastReview`	date	No	Date of previous accreditation review
`updatedIpAddress`	integer	Yes	IP Address associated with the updateAccount method call.
`field1`	string	No	Additional information relating to the account. Custom Field 1
`field2`	string	No	Additional information relating to the account. Custom Field 2
`field3`	string	No	Additional information relating to the account. Custom Field 3

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/updateAccount
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d accountId=A77854
 -d accountRegistration=John
 -d type=Individual
 -d entityType=Revocable Trust
 -d domesticYN=domestic account
 -d streetAddress1=First street
 -d streetAddress2=Third avenue
 -d city=ATLANTA
 -d state=GA
 -d zip=32526
 -d country=USA
 -d phone=41545218562
 -d emai=test@gmail.com
 -d taxID=875451545875855
 -d KYCstatus=pending
 -d AMLstatus=pending
 -d suitabilityScore=5
 -d suitabilityDate=02-18-2016
 -d suitabilityApprover=smith
 -d AccreditedStatus=pending
 -d AIlow=income
 -d AIdate=02-18-2016
 -d 506cLimit=50000
 -d accountTotalLimit=200000
 -d singleInvestmentLimit=100
 -d associatedAC=yes
 -d syndicate=no
 -d tags=terms
 -d notes=Personal Account
 -d approvalStatus=pending
 -d approvalPrincipal=Charles
 -d approvalLastReview=02-15-2016
 -d field1=some text
 -d field2=some text
 -d field3=some text

Response¶

Field	Type	Description
`accountId`	integer	ID for an account
`suitability`	string	Score from 1 to 5. With 5 being most suitable and 1 being least suitable
`approvalStatus`	string	Principal Approval Status: Pending, Approved, Not Approved

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": [
    {
      "accountId": "A77854",
      "suitabilityScore": "5",
      "approvalStatus": "pending"
    }
  ]
}

`POST /v3/updateAccountArchiveStatus`¶

Used to update an account to Archive status

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID generated by the API
`archiveStatus`	string	Yes	Change Status value e.g.: "0" or "1"

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateAccountArchiveStatus
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A12345
-d archiveStatus=1 or 0

Response¶

Field	Type	Description
`accountDetails`	string	Array of account details (accountId, archiveStatus)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "accountDetails": [
    {
      "accountId": "A12345",
      "archivestatus": "0"
    }
  ]
}

Accounts¶

Endpoints¶

GET /v3/accounts¶

Permissions¶

Authorization¶

Query Parameters¶

Filtering¶

POST /v3/addAccountNote¶

Parameters¶

Example Request¶

Response¶

PUT /v3/calculateSuitability¶

Parameters¶

Example Request¶

Response¶

Example Response¶

PUT /v3/createAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteAccountDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteSuitability¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAccountDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAccountNotes¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAllAccounts¶

Example Request¶

Response¶

Example Response¶

POST /v3/getSuitability¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/searchAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

PUT /v3/updateSuitability¶

Parameters¶

Example Request¶

Response¶

Example Response¶

PUT /v3/updateAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/updateAccountArchiveStatus¶

Parameters¶

Example Request¶

Response¶

Example Response¶

`GET /v3/accounts`¶

`POST /v3/addAccountNote`¶

`PUT /v3/calculateSuitability`¶

`PUT /v3/createAccount`¶

`POST /v3/deleteAccount`¶

`POST /v3/deleteAccountDocument`¶

`POST /v3/deleteSuitability`¶

`POST /v3/getAccount`¶

`POST /v3/getAccountDocument`¶

`POST /v3/getAccountNotes`¶

`POST /v3/getAllAccounts`¶

`POST /v3/getSuitability`¶

`POST /v3/searchAccount`¶

`PUT /v3/updateSuitability`¶

`PUT /v3/updateAccount`¶

`POST /v3/updateAccountArchiveStatus`¶