Serverless APIs¶
Deprecated — use the v3 REST API
The endpoints on this page belong to the legacy serverless surface and are deprecated. They remain reachable through the standard v3 REST API on the primary host (https://api-sandboxdash.norcapsecurities.com/v3/… in sandbox, https://api.norcapsecurities.com/v3/… in production). Migrate to the v3 routes shown below; the serverless host (tapi*.norcapsecurities.com) is being retired. Each endpoint links to its recommended replacement.
All requests require clientID and developerAPIKey parameters for authentication.
Base URL: https://api-sandboxdash.norcapsecurities.com
Endpoints¶
POST /v3/getLinkedAccounts¶
Deprecated
Use the v3 Links API instead — see GET /v3/links.
This API will show all accounts that are linked to the party id.
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
partyId | string | Yes | Link party ID that is generated by the API once a link is created(createLink) |
Example Request¶
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getLinkedAccounts
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=P12345
Response¶
| Field | Type | Description |
|---|---|---|
linkDetails | string | Array of link includes all information of the matched link (linkId, firstEntryType, firstEntry, relatedEntryType, relatedEntry, linkType, notes) |
Example Response¶
{
"statusCode": "101",
"statusDesc": "Ok",
"linkDetails": [
{
"id": "330",
"firstEntryType": "Account",
"firstEntry": "A51242",
"relatedEntry": "P99324",
"relatedEntryType": "IndivACParty",
"linkType": "owner",
"notes": ""
}
]
}
POST /v3/getAccount¶
Deprecated
Part of the legacy serverless surface — migrate to the v3 REST API. (This entry documents a securityid-based lookup returning trade details; for standard account retrieval see getAccount.)
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
securityid | string | Yes | Security ID |
Example Request¶
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAccount
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d securityid=77654
Response¶
| Field | Type | Description |
|---|---|---|
tradeDetails | string | Array of trade details |
Example Response¶
{
"statusCode": "101",
"statusDesc": "Ok",
"tradeDetails": [
{
"tradeId": "738346017",
"askOrderId": "147017465",
"bidOrderId": "879249632"
}
]
}
POST /v3/getTradeStatusesForOffering¶
Deprecated
Use getTradesForOffering instead.
Returns an array of trade IDs and current trade statuses associated with a specific Offering ID
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
offeringId | string | Yes | Offering ID that is generated by the API when an offering is created (createOffering) |
tradeStatus | string | No | Trade Status (Filter): CREATED \ |
Example Request¶
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getTradeStatusesForOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=8139
-d tradeStatus=CREATED
Response¶
| Field | Type | Description |
|---|---|---|
Offering Purchased Details | string | Returns an array of offering trades history |
Example Response¶
{
"statusCode": "101",
"statusDesc": "Ok",
"Offering purchased details": [
{
"tradeId": "114431043",
"accountId": "A49501",
"transactionType": "CreditCard",
"totalShares": "800.000000",
"unitPrice": "2.449500",
"totalAmount": "1959.600000",
"tradeStatus": "CREATED",
"RRApprovalStatus": "Pending",
"PrincipalApprovalStatus": "Pending",
"field1": "",
"field2": "",
"field3": "",
"esignStatus": "NOTSIGNED"
}
]