Documents¶

All requests require clientID and developerAPIKey parameters for authentication.

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

Endpoints¶

POST /v3/addDocumentsforOffering
POST /v3/addSubscriptionsforOffering
POST /v3/deleteDocumentsforOffering
POST /v3/deleteSubscriptionsforOffering
POST /v3/deleteAccountDocument
POST /v3/fetchSubscriptionDocuments
POST /v3/getAllSignedDocument
POST /v3/getDocumentsforOffering
POST /v3/getSubscriptionsforOffering
POST /v3/getTradeDocument
POST /v3/getTradeSignedDocument
POST /v3/getuploadPartyDocument
POST /v3/requestUploadPartyDocument
POST /v3/resendPartyAgreement
POST /v3/resendSubscriptionDocuments
POST /v3/sendNda
POST /v3/sendPartyAgreement
POST /v3/sendSubscriptionDocumentClient
POST /v3/updateDocumentforOffering
POST /v3/updateSubscriptionsforOffering
POST /v3/updateTradeDocArchivestatus
POST /v3/uploadAccountDocument
POST /v3/uploadEntityDocument
POST /v3/uploadPartyDocument
POST /v3/uploadTradeDocument

`POST /v3/addDocumentsforOffering`¶

This method is used to add a document to an offering. Only .pdf, .xls, and .docx files can be uploaded. Only PDF files are able to be watermarked. 50 MB max file upload.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	integer	Yes	Offering ID that is generated by the API once an offering is created (createOffering)
`documentTitle`	string	Yes	Title/label for the uploaded document
`documentFileReferenceCode`	string	Yes	Reference code for the uploaded document (can be any number to use for tracking)
`file\_name`	string	Yes	File name of the uploaded document. No special characters can be included in the file name.
`userfile0`	string	Yes	While uploading the PDF files, please provide a temporary file name. Prefix @ on the file name. Eg : @/tmp/phpAHi2ZC Request parameter should be userfile0, userfile1, userfile2,...userfilen for multiple documents upload. Refer Sample Request set below
`templateName`	conditional	No	Offering Document Template Name (can be used if using certain templates for tracking)
`approval`	string	No	Has the Document been approved by a Registered Principal? Yes or No
`supervisorname`	string	No	Name of the Approving Principal
`date`	integer	No	Date that the Document was Approved
`createdIpAddress`	string	No	IP Address of the addDocumentsforOffering method call

Example Request¶

SINGLE UPLOAD
--------------------------------------
curl --location 'https://api-sandboxdash.norcapsecurities.com/v3/addDocumentsforOffering' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'clientID="ClientID"' \
--form 'developerAPIKey="DeveloperAPIKey"' \
--form 'offeringId="1338707"' \
--form 'documentTitle="documentTitle0= LaurenTest"' \
--form 'documentFileReferenceCode="220323024315"' \
--form 'file_name="filename0= Test.pdf"' \
--form 'userfile0=@"/Users/laurencoalmer/Documents/Test.pdf"' \
--form 'approval="yes"' \
--form 'supervisorname="Lauren"' \
--form 'date="02-04-2016"' \
--form 'createdIpAddress="10.0.0.9"'

MULTIPLE UPLOAD
--------------------------------------
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/addDocumentsforOffering
--f developerAPIKey=somedeveloperkey
--f clientID=someclientid
--f offeringId=55593
--f documentTitle=documentTitle0=Tagme&documentTitle1=Tested
--f documentFileReferenceCode=ReferenceCode
--f file_name=filename0=page2.pdf&filename1=page3.pdf
--f userfile0=@/tmp/phpAHi2ZC
--f userfile1=@/tmp/phpDSGTUT
--f templateName=sample document
--f approval=yes
--f supervisorname=peter
--f date=02-04-2016
--f createdIpAddress=10.0.0.9

Response¶

Field	Type	Description
`offeringId`	integer	Offering ID generated by the API
`documentId`	string	Document ID generated by the API
`documentURL`	string	Uploaded document URL

Example Response¶

{
  statusCode: "101",
  statusDesc: "Ok",
  document_details: [
    {
      offeringId: "7671",
      documentId: "21344",
      documentReferenceCode: "24102016121212",
      documentURL: "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ241016060807.pdf"
    },
    {
      offeringId: "7671",
      documentId: "52348",
      documentReferenceCode: "24102016121212",
      documentURL: "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ2410160608071.pdf"
    }
  ]
}

`POST /v3/addSubscriptionsforOffering`¶

This method is used to add Subscription Documents to the offering through DocuSign. A template can be set up in DocuSign, allowing investor data to be auto-populated when the documents are sent. The Offering ID is required to add a Template Document. This method will return the Template ID as a successful response. To obtain the templateId needed for the templatename param, fetchSubscriptionDocuments can be used. A DocuSign business account connected to TransactAPI is required to use this method.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	string	Yes	Offering ID that is generated by the API once an offering is created(createOffering) for the offering that the subscription document template is to be added
`file\_name`	string	Yes	Template ID and Template Name (see example)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/addSubscriptionsforOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d file_name=templatename0= YourTemplateID--YourDocuSignTemplateName
-d offeringId=55593

Response¶

Field	Type	Description
`documentDetails`	string	Returns the template details as an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": [
    {
      "templateNameID": "55591",
      "templateName": "ABC Company",
      "offeringId": "55591"
    }
  ]
}

`POST /v3/deleteDocumentsforOffering`¶

This method is used to delete a document from an offering (addDocumentsforOffering).

Parameters¶

Parameter	Type	Required	Description
`documentId`	integer	Yes	Document ID that is generated by the API when an offering document is added (addDocumentsforOffering) of the document that is to be deleted

Example Request¶

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

Response¶

Field	Type	Description
`documentDetails`	string	Success Message

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": "document deleted successfully"
}

`POST /v3/deleteSubscriptionsforOffering`¶

This method is used to delete a Subscription Document from the offering. The templateId is required as a request parameter to delete.

Parameters¶

Parameter	Type	Required	Description
`templateId`	string	Yes	Template ID that is generated by the API once a subscription document is added (addSubscriptionsforOffering) of the document to be deleted

Example Request¶

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

Response¶

Field	Type	Description
`documentDetails`	string	Success Message

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": "Template deleted successfully"
}

`POST /v3/deleteAccountDocument`¶

Delete trade documents.

Parameters¶

Parameter	Type	Required	Description
`tradeId`	string	Yes	Trade ID that is generated by the API once the trade is created
`documentId`	string	Yes	User can get Document Id from getTradeDocument API Method

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deleteAccountDocument
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=12345678
-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/fetchSubscriptionDocuments`¶

Example Request¶

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

Response¶

Field	Type	Description
`document\_details`	string	Documents array

`POST /v3/getAllSignedDocument`¶

Get all signed document details

Parameters¶

Parameter	Type	Required	Description
`tradeId`	string	Yes	Trade ID that is generated by the API

Example Request¶

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

Response¶

Field	Type	Description
`SignedDocumentDetails`	string	Array of signed document details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "SignedDocumentDetails": {
    "orderId": "896835457",
    "id": "798817",
    "documentId": "271baf64-70e4-42e2-8310-ddf556d2fc76",
    "esignstatus": "SIGNED",
    "templateName": " 08a1f630-f3cc-4d66-84ff-e87c3f95f685--Advisory Test",
    "widgetTemplate": "",
    "docsId": null,
    "developerAPIKey": "xAgBUo4fIbTeCUPLfNs00E4oLPSOUpZra3i",
    "offeringId": "35034",
    "accountId": "A21451",
    "partyId": "P11462",
    "party_type": "IndivACParty",
    "escrowId": null,
    "transactionType": "WIRE",
    "totalAmount": "1000.000000",
    "totalShares": "10.000000",
    "orderStatus": "CREATED",
    "createdDate": "2019-02-19 12:28:16",
    "createdIpAddress": "182.71.143.70",
    "errors": "",
    "documentKey": "",
    "esignStatus": "NOTSIGNED",
    "users": "",
    "field1": "",
    "field2": "",
    "field3": "",
    "archived_status": "0"
  }
}

`POST /v3/getDocumentsforOffering`¶

This method is used to retrieve the document URL path and document details for a particular offering document (addDocumentsforOffering).

Parameters¶

Parameter	Type	Required	Description
`offeringId`	integer	Yes	Offering ID that is generated by the API once an offering is created (createOffering)

Example Request¶

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

Response¶

Field	Type	Description
`documentTitle`	string	Title of the document
`documentId`	integer	Document ID
`url`	string	Document URL after water marked

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": [
    {
      "documentTitle": "Offer Doc one",
      "documentId": "97891",
      "templateName": Offering Documents,
      "documentFileReferenceCode": "080916113242",
      "documentName": "GKrQ090916063243.pdf",
      "createdDate": "2016-09-09 06:32:43",
      "url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ090916063243.pdf"
    },
    {
      "documentTitle": "Offer Doc two",
      "documentId": "34122",
      "templateName": Offering Documents,
      "documentFileReferenceCode": "080916113242",
      "documentName": "GKrQ0909160632431.pdf",
      "createdDate": "2016-09-09 06:32:43",
      "url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ0909160632431.pdf"
    },
    {
      "documentTitle": "24oct2016_1",
      "documentId": "21344",
      "templateName": Offering Documents,
      "documentFileReferenceCode": "24102016121212",
      "documentName": "GKrQ241016060807.pdf",
      "createdDate": "2016-10-24 06:08:07",
      "url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ241016060807.pdf"
    },
    {
      "documentTitle": "24oct2016_2",
      "documentId": "52348",
      "templateName": Offering Documents,
      "documentFileReferenceCode": "24102016121212",
      "documentName": "GKrQ2410160608071.pdf",
      "createdDate": "2016-10-24 06:08:07",
      "url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ2410160608071.pdf"
    }
  ]
}

`POST /v3/getSubscriptionsforOffering`¶

This method is used to retrieve the subscription document template details for a particular offering.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	string	Yes	Offering ID that is generated by the API once an offering is created(createOffering)

Example Request¶

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

Response¶

Field	Type	Description
`documentDetails`	array	Returns the template details as an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": [
    {
      "templateId": "55",
      "templateName": "ABC Copmpany",
      "templateKey": "XEXZP636F3A3A36",
      "offeringId": "55591",
      "templateUrl": "https://secure.echosign.com/document/cp/2AAABLblqZhBzGsYNJkrcVqF58XhP0Myj3z0BuEPP2xT34rsr05gCx2se4fEFrJLxxSKvz6HwSiUshzEGc*/document.pdf",
      "createdDate": "2016-02-06 09:11:45"
    }
  ]
}

`POST /v3/getTradeDocument`¶

getTradeDocument list

Parameters¶

Parameter	Type	Required	Description
`tradeId`	string	Yes	Trade ID that is generated by the API once a trade is created

Example Request¶

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

Response¶

Field	Type	Description
`document\_details`	array	Array of trade document details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": [
    {
      "id": "796792",
      "tradeId": "1001354616",
      "virtualStatus": "ACTIVE",
      "documentid": "6YY3t",
      "documentTitle": " Test Document",
      "documentFileName": "3pmRSHDuk64876d232625cT.pdf",
      "documentFileReferenceCode": "120623070819",
      "createdDate": "2023-06-12",
      "archive_status": "0",
      "documentUrl": "https://api-sandboxdash.norcapsecurities.com/admin_v3/Upload_documentation/uploadDocument/dkFLVzF4MVZrUWphTjV3WitGMjZSQlBuWVRDTnA1WldKemhhaG9aYXhUVHRCUW5Ra0J6WnZCeTBUWEluczZwdm9NZURrclJTN0ZDaUpId0VuZCswamtqMmlqZDZkdS82dUZ2Z3d3OTdrZDVDTHhzRlRUZFh1OXM3Yno1MXZUQ2FyeXFyaGdLOHB5a3V6MWhJYk5pTDB3PT0="
    }
  ]
}

`POST /v3/getTradeSignedDocument`¶

Parameters¶

Parameter	Type	Required	Description
`tradeId`	string	Yes	Trade ID generated through createTrade

Example Request¶

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

Response¶

Field	Type	Description
`SignedDocumentDetails`	array	Returns an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "SignedDocumentDetails": [
    {
      "tradeId": "839685336",
      "documentId": "0af32e0b-7ba0-46ab-b3d7-c970ca4e55c9",
      "templateName": " 7087b67a-287a-469d-84f8-92abe32514b4--Fields Testing Document",
      "esignstatus": "SIGNED",
      "documentUrl": "https://api-sandboxdash.norcapsecurities.com/admin_v3//Upload_documentation/uploadDocument/RXplUjhMaWZQdFdVa1RCRHh4STNJRFZ1a0p2WlRmanNFK1NiNXFySXY2eVpMdkxiTGJONGJvV1h6NS93SUJRNDVTYWhQbFA0eE5udCsxNk5LTURUa0VLSjcxdzZaKzA1cC9LN3ovcllFRkN6WGlXbDY4YkNzT1gzZnFnLzVOSHlUVTVveUI0OG1RRVJpb29SeG5TWCtITm5GMkUrZitNL2wyMzJ6NmJqK2NDNzdReVZkSFcvTy8wbXh6VTdVMFA1MmFudDlmNWZibWxFZWdabUpQcHRVTDZMdUdRallCVXdGazg1SGJwOWlvZU8wZGduNEFMMDYyZXlaUnM0MU5QNlkwQkk4c25lNXc5SU1CemhVVGtzSXdFZk52TFd3THYvS2tab2dCV0R2SjNicXVXSWNFZEoyMmswdmpnNVlFamQ="
    }
  ]
}

`POST /v3/getuploadPartyDocument`¶

This method will return the document URL path and document details for a particular party document.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API once an individual party is created (createParty)

Example Request¶

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

Response¶

Field	Type	Description
`document\_details`	string	Get document details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDocumentDetails": [
    {
      "id": "562",
      "partyid": "P08374",
      "documentid": "UAVdq",
      "documentTitle": " Party Doc Check",
      "documentFileName": "GKrQ190918113557.pdf",
      "documentFileReferenceCode": "190918113557",
      "createdDate": "2018-09-19",
      "documentUrl": "https://api-sandboxdash.norcapsecurities.com/admin_v3/Upload_documentation/uploadDocument/cjdPQ2FlUm1LY0dZNzBkc1Z0bGt0cGpLcUhiV3FOUXV6bjJraW1XaTlVdFllWXBOTmNMTktFUStpSWNtVm5Yb1lYdkllRVNMb0pOZnU5RXM5eFdaVGp2Zm5mVllyc3ZLelpsdCtnVC8vdFVuemdOR282Rjg4bTgxb1hCaTJzZE9kMGkyMEMrM3VPMW9ETnlmcm5Vc2pBPT0="
    },
    {
      "id": "563",
      "partyid": "P08374",
      "documentid": "YBHE3",
      "documentTitle": " New Doc Check",
      "documentFileName": "GKrQ190918113617.pdf",
      "documentFileReferenceCode": "190918113617",
      "createdDate": "2018-09-19",
      "documentUrl": "https://api-sandboxdash.norcapsecurities.com/admin_v3/Upload_documentation/uploadDocument/cjdPQ2FlUm1LY0dZNzBkc1Z0bGt0cGpLcUhiV3FOUXV6bjJraW1XaTlVc1E1YTRZakRrd3NhTGdpczlwSmVaQTRqQjVVcGZxOUFJTWRoa0hzR1d5SFcveG92bHB1cG14UHY4OVBjOHVVOEkveTR3Sm1OVTFmYnM2ZXZGWWlUdFEvL2h0L2lqayttOExDUzJpdTV1bThBPT0="
    }
  ]
}

`POST /v3/requestUploadPartyDocument`¶

This method is used to collect documents when North Capital is providing a manual review of KYC/AML. There is an additional reviewing fee that will be charged to use this method.

Parameters¶

Parameter	Type	Required	Description
`requestId`	string	Yes	Party Request ID Generated by API
`investorId`	string	Yes	Party Id or Entity Id or Account Id Generated by API
`documentTitle`	string	Yes	Uploaded document title. Legacy users can still use the prefix "documentTitle0=" but it is no longer required.
`userfile0`	string	Yes	While uploading the PDF files, please provide a temporary file name. Prefix @ on the file name. Eg : @/tmp/phpAHi2ZC Request parameter should be userfile0 for documents upload.Refer Sample Request set below
`createdIpAddress`	string	Yes	Requested IP Address

Example Request¶

curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/v3/requestUploadPartyDocument' 
--form 'documentTitle="documentTitle0= NEw REquest DOc&"' 
--form 'userfile0=@"/C:/Users/marim/OneDrive/Desktop/3pmR29DZ562837683a10bcAI.pdf"' 
--form 'developerAPIKey=""' 
--form 'clientID=""' 
--form 'requestId=""' 
--form 'investorId=""' 
--form 'createdIpAddress="117.221.66.34"'

Response¶

Field	Type	Description
`documentDetails`	string	Document has been uploaded successfully

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": "Document has been uploaded Successfully"
}

`POST /v3/resendPartyAgreement`¶

This method is used to send the document/optional agreement to a party for signature. This document is usually presented to the party as an agreement that needs to be signed before they are allowed to invest (investor agreement). A Docusign business account connected to TransactAPI is required to use this method.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API when an individual party is created (createParty)

Example Request¶

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

Response¶

Field	Type	Description
`partyDetails`	string	Party details of the match parties (partyId, documentKey)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": {
    "partyId": "7176503",
    "documentKey": "XLUR7ZL6L2BXBXD"
  }
}

`POST /v3/resendSubscriptionDocuments`¶

The Resend Subscription Documents endpoint handles the re-delivery of previously sent subscription documents to investors.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	integer	Yes	Offering ID that is generated by the API when an offering is created (createOffering)
`accountId`	string	Yes	Account ID that is generated by the API when an account is created (createAccount)
`tradeId`	integer	Yes	Trade ID that is generated by the API when an account is created (createTrade)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/resendSubscriptionDocuments
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=273410
-d accountId=A12345
-d tradeId=1001347178

Response¶

Field	Type	Description
`document\_details`	string	Document details of the matched Party (documentKey, esignStatus, partyId)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": [
    {
      "documentKey": "XS8TLG54E6Q226M",
      "esignStatus": "NOTSIGNED",
      "accountId": "A12345"
    },
    {
      "documentKey": "XS8TLGQ476P37X5",
      "esignStatus": "NOTSIGNED",
      "accountId": "A12345"
    },
    {
      "documentKey": "XS8VFT92I3M4LX9",
      "esignStatus": "NOTSIGNED",
      "accountId": "A12345"
    }
  ]
}

`POST /v3/sendNda`¶

This method is used to send the subscription documents to sign.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`document\_details`	string	Document details of the matched Party (documentKey, esignStatus, partyId)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": [
    {
      "documentKey": "XS8TLG54E6Q226M",
      "esignStatus": "NOTSIGNED",
      "accountId": "A12345",
      "tradeId": "123455789"
    },
    {
      "documentKey": "XS8TLGQ476P37X5",
      "esignStatus": "NOTSIGNED",
      "accountId": "A12345",
      "tradeId": "123455789"
    },
    {
      "documentKey": "XS8VFT92I3M4LX9",
      "esignStatus": "NOTSIGNED",
      "accountId": "A12345"
    }
  ]
}

`POST /v3/sendPartyAgreement`¶

This method is used to send the document/optional agreement to the party to sign. This document is usually presented to the party as an agreement that needs to be signed before they are allowed to invest (investor agreement).

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API when an individual party is created (createParty)

Example Request¶

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

Response¶

Field	Type	Description
`partyDetails`	string	Party details of the matched parties (partyId, documentKey)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": {
    "partyId": "7176503",
    "documentKey": "XLUR7ZL6L2BXBXD"
  }
}

`POST /v3/sendSubscriptionDocumentClient`¶

Create a DocuSign envelope and provide a URL to a view where the envelope can be signed.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	string	Yes	Offering ID that is generated by the API when an offering is created (createOffering)
`accountId`	string	Yes	Account ID that is generated by the API once an account is created (createAccount)
`tradeId`	string	Yes	Trade ID that is generated by the API when an trade is created (createTrade)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/sendSubscriptionDocumentClient
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=273410
-d accountId=A12345 
-d tradeId=123456789

Response¶

Field	Type	Description
`document\_details`	string	Send signed URL in document details array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": {
    "url": "https://na3.docusign.net/Signing/StartInSession.aspx?t=3b12c557-f7b4-4453-a1d1-b85487fsdfg3c"
  }
}

`POST /v3/updateDocumentforOffering`¶

This method is used to update a document with a new document for an offering. The existing document will be replaced with the new document.

Parameters¶

Parameter	Type	Required	Description
`documentId`	integer	Yes	Document ID that is generated by the API when an offering document is added (addDocumentsforOffering) of the document that is to be updated.
`documentTitle`	string	Yes	The new Title/label for the uploaded document
`documentFileReferenceCode`	string	Yes	The new reference code for the uploaded document (can be any number to use for tracking)
`file\_name`	string	Yes	The new file name of the uploaded document
`updatedIpAddress`	string	No	IP Address of the updateDocumentforOffering method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateDocumentforOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d documentId=55593
-d documentTitle=Tagme
-d documentFileReferenceCode=ReferenceCode
-d file_name=mypdf_new.pdf
-d updatedIpAddress=10.0.0.9

Response¶

Field	Type	Description
`offeringID`	integer	Offering ID generated by the API
`documentId`	integer	Document ID generated by the API
`documentURL`	string	Uploaded document URL

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": [
    {
      "offeringId": "55591",
      "documentId": "62801",
      "documentURL": "https://api-sandboxdash.norcapsecurities.com/stamp/PDF/page27.pdf"
    }
  ]
}

`POST /v3/updateSubscriptionsforOffering`¶

This method is used to update a Subscription Document for the offering. The template is set up in either Docusign or Echosign, allowing investor data to be auto-populated when the documents are sent. The existing template will be replaced with the new template.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	string	Yes	Offering ID that is generated by the API once an offering is created(createOffering) for the offering that the subscription document template is to be replaced.
`templateId`	string	Yes	Template ID that is generated by the API once a subscription document is added(addSubscriptionsforOffering)
`templatename`	string	Yes	The name of the replacement template as it is titled in Docusign or Echosign.
`updatedIpAddress`	string	No	IP Address of the updateSubscriptionsforOffering method call.

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateSubscriptionsforOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=55682
-d templateId=55593
-d templatename=sample document
-d updatedIpAddress=10.0.0.9

Response¶

Field	Type	Description
`offeringId`	string	Offering ID generated by the API
`templateID`	string	Template ID generated by the API
`templateName`	string	Uploaded template name

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": [
    {
      "offeringId": "55591",
      "templateId": "62801",
      "templatename": "ABC Company"
    }
  ]

`POST /v3/updateTradeDocArchivestatus`¶

Update trade document archive status

Parameters¶

Parameter	Type	Required	Description
`tradeId`	string	Yes	Trade ID generated by the API
`documentFileReferenceCode`	string	Yes	Document reference code generated by the API
`archiveStatus`	string	Yes	Change Status value eg: "0" or "1"

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateTradeDocArchivestatus
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=141103099
-d documentFileReferenceCode=141103099
-d archiveStatus=1 or 0

Response¶

Field	Type	Description
`tradeDetails`	string	Array of trade details (tradeId, documentId, orderStatus)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "tradeDocumentDetails": [
    {
      "tradeId": "923209860",
      "virtualStatus": "ACTIVE",
      "documentid": "3c3Gu",
      "documentTitle": " Test trade document",
      "documentFileName": "GKrQ100417045821.pdf",
      "documentFileReferenceCode": "100417045821",
      "createdDate": "2017-04-10 19:08:19",
      "archiveStatus": "0"
    }
  ]
}

`POST /v3/uploadAccountDocument`¶

Upload a document and associate it with an account

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Account ID that is generated by the API when an account is created (createAccount)
`documentTitle`	string	Yes	Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field
`file\_name`	string	Yes	Uploaded document file name. Please use prefix "filename0=" in the value of file_name field
`userfile0`	string	Yes	Raw file data. Specification of raw file data is application specific. Accepted file types are PDF, JPG, PNG, HEIC and BMP. Minimum file size is 1 kB. Maximum file size is 100 MB. Please refer to the Sample Requests section for reference implementations.
`createdIpAddress`	string	No	Requested IP Address

Example Request¶

curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/v3/uploadAccountDocument' 
--form 'clientID=someclientid'
--form 'accountId=someaccountid'
--form 'createdIpAddress="42.106.177.219"' 
--form 'file_name="filename0=Testing Document Size12.pdf"' 
--form 'userfile0=@"/path/to/file"' 
--form 'documentTitle="documentTitle0=Testing Document Size12.pdf"' 
--form 'developerAPIKey=somedeveloperAPIkey'

Response¶

Field	Type	Description
`document\_details`	string	Document has been uploaded
`Errors(s)`	string	(optional) provides more information about error response

`POST /v3/uploadEntityDocument`¶

This method is used to upload a document to a particular entity party (createEntity). The Party ID is required as a request parameter for this method. Files cannot be larger than 100 MB.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Entity ID that is generated by the API when an entity is created (createEntity)
`documentTitle`	string	Yes	Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field
`file\_name`	string	Yes	Uploaded document file name. Please use prefix "filename0=" in the value of file_name field
`userfile0`	string	Yes	Raw file data. Specification of raw file data is application specific. Accepted file types are PDF, JPG, PNG, HEIC and BMP. Minimum file size is 1 kB. Maximum file size is 100 MB. Please refer to the Sample Requests section for reference implementations.
`createdIpAddress`	string	No	Requested IP Address

Example Request¶

curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/v3/uploadEntityDocument' 
--form 'clientID=someclientid'
--form 'partyId=someentityid'
--form 'createdIpAddress="127.0.0.1"' 
--form 'file_name="filename0=Testing Document Size12.pdf"' 
--form 'userfile0=@"/path/to/file"' 
--form 'documentTitle="documentTitle0=Testing Document Size12.pdf"' 
--form 'developerAPIKey=somedeveloperAPIkey'

Response¶

Field	Type	Description
`document\_details`	string	Document has been uploaded
`Errors(s)`	string	(optional) provides more information about error response

`POST /v3/uploadPartyDocument`¶

This endpoint is used to upload a document and associate it with an individual party. A valid party must exist to use this endpoint, and parties can be created using the createParty endpoint. The request must use the multipart/form-data content type to ensure proper handling of file uploads.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API when a party is created (createParty)
`documentTitle`	string	Yes	Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field
`file\_name`	string	Yes	Uploaded document file name. Please use prefix "filename0=" in the value of file_name field
`userfile0`	string	Yes	Raw file data. Specification of raw file data is application specific. Accepted file types are PDF, JPG, PNG, HEIC and BMP. Minimum file size is 1 kB. Maximum file size is 100 MB. Please refer to the Sample Requests section for reference implementations.
`createdIpAddress`	string	Yes	Requested IP Address

Example Request¶

curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/v3/uploadPartyDocument' 
--form 'clientID=someclientid'
--form 'partyId=somepartyid'
--form 'createdIpAddress="42.106.177.219"' 
--form 'file_name="filename0=Testing Document Size12.pdf"' 
--form 'userfile0=@"/path/to/file"' 
--form 'documentTitle="documentTitle0=Testing Document Size12.pdf"' 
--form 'developerAPIKey=somedeveloperAPIkey'

Response¶

Field	Type	Description
`document\_details`	string	Document has been uploaded
`Errors(s)`	string	(optional) provides more information about error response

`POST /v3/uploadTradeDocument`¶

This method is used to upload a document to a particular trade (createTrade). The TradeID is required as a request parameter for this method. Files cannot be larger than 100 MB.

Parameters¶

Parameter	Type	Required	Description
`tradeId`	string	Yes	Trade ID that is generated by the API when a trade is created (createTrade)
`documentTitle`	string	Yes	Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field
`file\_name`	string	Yes	Uploaded document file name. Please use prefix "filename0=" in the value of file_name field
`userfile0`	string	Yes	Raw file data. Specification of raw file data is application specific. Accepted file types are PDF, JPG, PNG, HEIC and BMP. Minimum file size is 1 kB. Maximum file size is 100 MB. Please refer to the Sample Requests section for reference implementations.
`createdIpAddress`	string	No	Requested IP Address

Example Request¶

curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/v3/uploadTradeDocument' 
--form 'clientID=someclientid'
--form 'tradeId=sometradeid'
--form 'createdIpAddress="127.0.0.1"' 
--form 'file_name="filename0=Testing Document Size12.pdf"' 
--form 'userfile0=@"/path/to/file"' 
--form 'documentTitle="documentTitle0=Testing Document Size12.pdf"' 
--form 'developerAPIKey=somedeveloperAPIkey'

Response¶

Field	Type	Description
`document\_details`	string	Document has been uploaded
`Errors(s)`	string	(optional) provides more information about error response

Documents¶

Endpoints¶

POST /v3/addDocumentsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/addSubscriptionsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteDocumentsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteSubscriptionsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteAccountDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/fetchSubscriptionDocuments¶

Example Request¶

Response¶

POST /v3/getAllSignedDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getDocumentsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getSubscriptionsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getTradeDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getTradeSignedDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getuploadPartyDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/requestUploadPartyDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/resendPartyAgreement¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/resendSubscriptionDocuments¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/sendNda¶

Parameters¶

Example Request¶

Response¶

Example Response¶

`POST /v3/addDocumentsforOffering`¶

`POST /v3/addSubscriptionsforOffering`¶

`POST /v3/deleteDocumentsforOffering`¶

`POST /v3/deleteSubscriptionsforOffering`¶

`POST /v3/deleteAccountDocument`¶

`POST /v3/fetchSubscriptionDocuments`¶

`POST /v3/getAllSignedDocument`¶

`POST /v3/getDocumentsforOffering`¶

`POST /v3/getSubscriptionsforOffering`¶

`POST /v3/getTradeDocument`¶

`POST /v3/getTradeSignedDocument`¶

`POST /v3/getuploadPartyDocument`¶

`POST /v3/requestUploadPartyDocument`¶

`POST /v3/resendPartyAgreement`¶

`POST /v3/resendSubscriptionDocuments`¶

`POST /v3/sendNda`¶

`POST /v3/sendPartyAgreement`¶

`POST /v3/sendSubscriptionDocumentClient`¶

`POST /v3/updateDocumentforOffering`¶

`POST /v3/updateSubscriptionsforOffering`¶

`POST /v3/updateTradeDocArchivestatus`¶

`POST /v3/uploadAccountDocument`¶

`POST /v3/uploadEntityDocument`¶

`POST /v3/uploadPartyDocument`¶

`POST /v3/uploadTradeDocument`¶