Offerings¶

All requests require clientID and developerAPIKey parameters for authentication.

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

Endpoints¶

POST /v3/cancelOffering
POST /v3/closeOffering
PUT /v3/createOffering
POST /v3/deleteOffering
POST /v3/getAllOffers
POST /v3/getCustodianDetailsforOffering
POST /v3/getOffering
POST /v3/getOfferingDetails
POST /v3/getOfferingPurchaseHistory
POST /v3/getOfferingStatus
GET /v3/offerings
POST /v3/searchOffering
POST /v3/updateOffering
POST /v3/updateOfferingDocument

`POST /v3/cancelOffering`¶

This method updates the offering status to "Canceled." Investor refunds should be submitted via cancelInvestment

Parameters¶

Parameter	Type	Required	Description
`offeringId`	integer	Yes	Offering ID that is generated by the API when an Offering is created(createOffering) of the offering that is to be cancelled

Example Request¶

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

Response¶

Field	Type	Description
`offeringDetails`	string	Returns the cancelled offering details as an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "Financial offering details": "41994"
}

`POST /v3/closeOffering`¶

This method closes the offering and cannot be invoked until all trade statuses are one of the following: Funded, Settled, Canceled or Unwind Settled. The offering can only be closed once all funding activity has been completed. Please note that this does NOT update trade statuses to "Settled.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	string	Yes	Offering ID that is generated by the API when an Offering is created (createOffering) of the offering that is to be closed.

Example Request¶

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

Response¶

Field	Type	Description
`offeringId`	string	Returns the Closed Offering ID

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "OfferID": "59663"
}

`PUT /v3/createOffering`¶

This method is used to create an offering/deal in Transact API. This method will return the Offering ID as a successful response.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	integer	Yes	Issuer ID that is generated by the API when an Issuer is created (createIssuer)
`issueName`	string	Yes	Name of the Offering
`issueType`	conditional	Yes	Type of Offering: Equity, Debt, Hybrid, Fund
`targetAmount`	decimal	Yes	The Target Amount of the Raise (should be LESS than Maximum Amount)
`minAmount`	decimal	Yes	The Minimum amount that can be invested at one time
`maxAmount`	decimal	Yes	The Maximum amount of the offering (cap amount)
`unitPrice`	decimal	Yes	Price per Unit (unit/share price). The investment can only be made in increments of this number.
`startDate`	string	Yes	Offering Start Date
`endDate`	string	Yes	Offering End Date
`offeringText`	string	Yes	A brief description of the offering.
`stampingText`	string	Yes	The text that is watermarked on the offering documents(addDocumentsforOffering). ( Example: "Confidential" )
`createIPAddress`	string	No	Requested IP Address
`escrowAccountNumber`	string	No	Escrow Account Number
`field1`	string	No	Additional information relating to the offering. Custom Field 1
`field2`	string	No	Additional information relating to the offering. Custom Field 2
`field3`	string	No	Additional information relating to the offering. Custom Field 3

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/createOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerId=564631
-d issueName=My issue
-d issueType=debt
-d targetAmount=9000.00
-d minAmount=100.00
-d maxAmount=10000.00
-d unitPrice=25.50
-d startDate=08-23-2014
-d endDate=08-23-2015
-d offeringText=My Text
-d stampingText=Sample Text
-d escrowAccountNumber=Sample Text
-d field1=Sample Text
-d field2=Sample Text
-d field3=Sample Text
-d createdIPAddress=10.0.0.9

Response¶

Field	Type	Description
`offeringDetails`	string[]	The first value should be ignored. The second value is an array with one element, the new `<object>` created by this request. See details below

Field	Type	Description
`offeringId`	integer	Generated Offering ID
`offeringStatus`	string	Status of offering like Pending \

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    true,
    [
      {
        "offeringId": "48587",
        "offeringStatus": "Pending"
      }
    ]
  ]
}

`POST /v3/deleteOffering`¶

This method deletes an offering. This is a virtual delete. The offering ID is required as a request parameter to delete the offering.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	string	Yes	Offering ID that is generated by the API when an Offering is created (createOffering) of the offering that is to be deleted

Example Request¶

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

Response¶

Field	Type	Description
`offeringDetails`	string	Returns the delete offering details as an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": "41994"
}

`POST /v3/getAllOffers`¶

Deprecated

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

Get all offers for a given client

Example Request¶

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

Response¶

Field	Type	Description
`offeringDetails`	string	Get offering details as an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    {
      "issuerId": "596423",
      "offeringId": "97618",
      "issueName": "Lauren Test Offering",
      "issueType": "Equity",
      "targetAmount": "37000.000000",
      "minAmount": "1.000000",
      "maxAmount": "37000000.000000",
      "unitPrice": "5.000000",
      "totalShares": "7400000.000000",
      "remainingShares": "7372547.453946",
      "startDate": "02-11-2021",
      "endDate": "02-14-2022",
      "offeringStatus": "Pending",
      "offeringText": "Offering Text",
      "stampingText": "Watermark",
      "createdDate": "2021-02-11 14:38:36",
      "createdIPAddress": "97.117.119.58"
    },
    {
      "issuerId": "596423",
      "offeringId": "1126643",
      "issueName": "Lauren Test Offering",
      "issueType": "Equity",
      "targetAmount": "100.000000",
      "minAmount": "1.000000",
      "maxAmount": "1000.000000",
      "unitPrice": "1.000000",
      "totalShares": "1000.000000",
      "remainingShares": "1000.000000",
      "startDate": "05-18-2022",
      "endDate": "05-18-2023",
      "offeringStatus": "closed",
      "offeringText": "Test",
      "stampingText": "Confidential",
      "createdDate": "2022-05-18 22:26:51",
      "createdIPAddress": "166.70.186.226"
    },
    {
      "issuerId": "596423",
      "offeringId": "1325825",
      "issueName": "Orca Computers",
      "issueType": "Equity",
      "targetAmount": "100000.000000",
      "minAmount": "1000.000000",
      "maxAmount": "10000000.000000",
      "unitPrice": "1000.000000",
      "totalShares": "10000.000000",
      "remainingShares": "10000.000000",
      "startDate": "01-12-1999",
      "endDate": "01-12-1999",
      "offeringStatus": "Pending",
      "offeringText": "Innovating Computers",
      "stampingText": "Orca Computers",
      "createdDate": "2023-01-12 18:12:19",
      "createdIPAddress": "172.16.1.142"
    }
  ]
}

`POST /v3/getCustodianDetailsforOffering`¶

This method is used to retrieve the wire and check funding instructions for the custodian of a specific offering.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`custodianDetails`	string	Array of custodian details includes all information of the matched custodian

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "custodianDetails": {
    "name": "Kingdom Trust",
    "additionaldescription": "Additional Test Content",
    "wire": {
      "description": "Please send wires to the following",
      "receivingbank": "FNB BANK",
      "accountnumber": "987654321",
      "routingnumber": "123456789",
      "reference": "NC-[YOUR NAME] AND 123456789",
      "address1": "101 E Boradway, PO Box 369",
      "address2": "",
      "city": "Murray",
      "state": "KY",
      "zip": "42071",
      "country": "USA",
      "receivingfinancialinstitution": "Kingdom Trust",
      "swiftcode": "8745965",
      "beneficiary": "Kingdom Trust",
      "beneficiaryaccountnumber": "14258966"
    },
    "check": {
      "description": "To send check through Fedex or UPS",
      "mailto": "The Kingdom Trust Company",
      "address1": "1105 St Rt 121 N",
      "address2": "Unit B",
      "city": "Murray",
      "state": "KY",
      "zip": "42071",
      "country": "USA",
      "postaldescription": "To send via regular mail",
      "postaladdress": "The Kingdom Trust Company PO Box 870",
      "postalcity": "Murray",
      "postalstate": "KY",
      "postalzip": "42071",
      "postalcountry": "USA"
    }
  }
}

`POST /v3/getOffering`¶

This method is used to get all the details of an offering. The Offering ID is required to get the information.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`offeringDetails`	string	Details of the matched offer trades amount as an array

Field	Type	Description
`issuerId`	string	Issuer ID that is generated by the API when an Issuer is created (createIssuer)
`offeringId`	string	API Status Description
`issueName`	string	Name of the Offering
`issueType`	string	Type of Offering: Equity, Debt, Hybrid, Fund
`targetAmount`	string	The Target Amount of the Raise (should be LESS than Maximum Amount)
`minAmount`	string	The Minimum amount that can be invested at one time
`maxAmount`	string	The Maximum amount of the offering (cap amount)
`unitPrice`	string	Price per Unit (unit/share price). The investment can only be made in increments of this number.
`totalShares`	string	Total number shares for this offering
`remainingShares`	string	Shares remaining for this offering
`startDate`	string	Offering Start Date
`endDate`	string	Offering End Date
`offeringStatus`	string	Offering Status: Approved, Pending, Denied
`stampingText`	string	The text that is watermarked on the offering documents(addDocumentsforOffering). ( Example: "Confidential" )
`escrowAccountNumber`	string	Escrow Account Number
`field1`	string	Additional information relating to the offering. Custom Field 1
`field2`	string	Additional information relating to the offering. Custom Field 2
`field3`	string	Additional information relating to the offering. Custom Field 3
`offeringText`	string	A brief description of the offering.

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    {
      "issuerId": "596423",
      "offeringId": "97618",
      "issueName": "Lauren Test Offering",
      "issueType": "Equity",
      "targetAmount": "37000.000000",
      "minAmount": "1.000000",
      "maxAmount": "37000.000000",
      "unitPrice": "1.000000",
      "totalShares": "37000.000000",
      "remainingShares": "14712.050946",
      "startDate": "02-11-2021",
      "endDate": "02-14-2022",
      "offeringStatus": "Pending",
      "offeringText": "Offering Text",
      "stampingText": "Watermark",
      "escrowAccountNumber": null,
      "field1": null,
      "field2": null,
      "field3": null
    }
  ]
}

`POST /v3/getOfferingDetails`¶

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`Offering Purchased Details`	string	Details of the matched offer trades purchased amount as an array

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "Offering purchased details": [
    {
      "committedAmount": "20821.762404",
      "fundedAmount": "3162.985000",
      "pendingAmount": "17658.777404",
      "escrowAccountNumber": "484535498714"
    }
  ]
}

`POST /v3/getOfferingPurchaseHistory`¶

This method is used to retrieve the history of all trades (and details of the trades) created for an offering. The Offering ID is required as a request parameter to fetch the purchase history.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`offeringPurchasedDetails`	string	Returns an array of offering purchased history

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "Offering purchased details": {
    "offering_purchase_history": [
      {
        "tradeId": "539263448",
        "accountId": "A55779",
        "offeringId": "8139",
        "totalAmount": "10.000000",
        "totalShares": "10.000000",
        "purchaseDate": "2016-10-14 16:26:12",
        "accountName": "Sara Individual",
        "offeringTotalShares": "100000.000000",
        "targetAmount": "89890.000000",
        "remainingShares": "97892.000000"
      },
      {
        "tradeId": "962934972",
        "accountId": "A07061",
        "offeringId": "8139",
        "totalAmount": "100.000000",
        "totalShares": "100.000000",
        "purchaseDate": "2016-10-14 16:18:16",
        "accountName": "Borazan Joint",
        "offeringTotalShares": "100000.000000",
        "targetAmount": "89890.000000",
        "remainingShares": "97892.000000"
      },
      {
        "tradeId": "653879815",
        "accountId": "A07061",
        "offeringId": "8139",
        "totalAmount": "999.000000",
        "totalShares": "999.000000",
        "purchaseDate": "2016-07-19 19:02:40",
        "accountName": "Borazan Joint",
        "offeringTotalShares": "100000.000000",
        "targetAmount": "89890.000000",
        "remainingShares": "97892.000000"
      },
      {
        "tradeId": "425903603",
        "accountId": "A07061",
        "offeringId": "8139",
        "totalAmount": "999.000000",
        "totalShares": "999.000000",
        "purchaseDate": "2016-07-19 18:52:05",
        "accountName": "Borazan Joint",
        "offeringTotalShares": "100000.000000",
        "targetAmount": "89890.000000",
        "remainingShares": "97892.000000"
      }
    ],
    "totalAmountRaised": 2108,
    "totalShares": 400000,
    "totalSharesPurchased": 2108,
    "totalSharesLeft": "97892.000000",
    "balanceAmount": "89890.000000",
    "offeringId": "8139"
  }
}

`POST /v3/getOfferingStatus`¶

This method is used to retrieve the approval status of a specific offering.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`offeringId`	integer	Offering ID generated by the API
`offeringStatus`	string	Status of the offering Pending \

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": {
    "offeringId": "55591",
    "offeringStatus": "Pending"
  }
}

`GET /v3/offerings`¶

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

Permissions¶

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

This scope can be assigned by system admins through the API or Transact Portal.

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 offering in the list.
`limit`	integer	10	The maximum number of offerings to return. Max value is 500.
`deleted`	boolean	false	Include deleted offerings in response.
`filter`	string (JSON)		Filter results by specific fields.
`sort`	string		Sort order specification.

Filtering and Sorting¶

For more information see Working with List Endpoints.

`POST /v3/searchOffering`¶

This method is used to search all created offerings using a keyword and will return all matches for that keyword.

Parameters¶

Parameter	Type	Required	Description
`searchKeyword`	string	Yes	Keyword to search
`issuerId`	integer	Yes	Issuer ID that is generated by the API when an Issuer is created (createIssuer)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/searchOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d searchKeyword=87982
-d issuerId=75509

Response¶

Field	Type	Description
`offeringDetails`	string	Details of the matched offering as an array (issuerId, offeringId, issueName, issueType, targetAmount, minAmount, maxAmount, unitPrice, totalShares, remainingShares, startDate, endDate, offeringStatus, offeringText, stampingText)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    {
      "issuerId": "75509",
      "offeringId": "87982",
      "issueName": "John Smith",
      "issueType": "equity",
      "targetAmount": "10000.000000",
      "minAmount": "11000.000000",
      "maxAmount": "12000.000000",
      "unitPrice": "100.000000",
      "totalShares": "120.000000",
      "remainingShares": "120.000000",
      "startDate": "02-02-2016",
      "endDate": "04-04-2016",
      "offeringStatus": "approved",
      "offeringText": "Offering Text Added",
      "stampingText": "Stamping Text Added"
    }
  ]
}

`POST /v3/updateOffering`¶

This method is used to update an offering in Transact API. The Offering ID is required as a request parameter for the update to take place.

Parameters¶

Parameter	Type	Required	Description
`offeringId`	integer	Yes	Offering ID that is generated by the API when an Offering is created (createOffering)
`issueName`	string	Yes	Name of the Offering
`issueType`	conditional	Yes	Type of Offering: Equity, Debt, Hybrid, Fund
`targetAmount`	decimal	Yes	The Target Amount of the Raise (should be LESS than Maximum Amount)
`minAmount`	decimal	Yes	The Minimum amount that can be invested at one time
`maxAmount`	decimal	Yes	The Maximum amount of the offering (cap amount)
`unitPrice`	decimal	Yes	Price per Unit (unit/share price). The investment can only be made in increments of this number
`startDate`	string	Yes	Offering Start Date
`endDate`	string	Yes	Offering End Date
`offeringStatus`	string	Yes	Optional Approval Status of the offering. Statuses are Pending, Approved, Denied
`offeringText`	string	Yes	A brief description of the offering
`providerId`	integer	No	Custodian / Escrow ID of the institution that is holding the escrow account for the offering
`stampingText`	string	No	The text that is watermarked on the offering documents(addDocumentsforOffering). (Example: "Confidential")
`updatedIPAddress`	integer	No	Updated IP Address
`escrowAccountNumber`	string	No	Escrow Account Number
`field1`	string	No	Additional information relating to the offering. Custom Field 1
`field2`	string	No	Additional information relating to the offering. Custom Field 2
`field3`	string	No	Additional information relating to the offering. Custom Field 3

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=65432
-d issueName=John Smith
-d issueType=debt
-d targetAmount=8100.00
-d minAmount=101.00
-d maxAmount=10050.00
-d unitPrice=25.75
-d startDate=03-23-2016
-d endDate=03-23-2016
-d offeringStatus=approved
-d offeringText=Offering Text
-d stampingText=Sample Text
-d escrowAccountNumber=Sample Text
-d field1=Sample Text
-d field2=Sample Text
-d field3=Sample Text
-d updatedIPaddress=10.0.0.110

Response¶

Field	Type	Description
`offeringId`	integer	Generated Offering ID
`providerId`	integer	Custodian / Escrow ID of the institution that is holding the escrow account for the offering
`offeringStatus`	string	Status of offering like Pending \

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    true,
    [
      {
        "offeringId": "65432",
        "offeringStatus": "Approved"
      }
    ]
  ]
}

`POST /v3/updateOfferingDocument`¶

Parameters¶

Parameter	Type	Required	Description
`documentId`	string	Yes	Offering document unique ID
`documentTitle`	string	Yes	Offering document title
`documentFileReferenceCode`	string	Yes	Offering document reference ID
`offeringId`	string	Yes	Offering ID

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateOfferingDocument 
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d offeringId=12345
-d documentId=7984654
-d documentTitle=Uploaded file name
-d documentFileReferenceCode=7465

Response¶

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

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": [
    {
      "offeringId": "55591",
      "documentId": "62801",      
    }
  ]
}

Offerings¶

Endpoints¶

POST /v3/cancelOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/closeOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

PUT /v3/createOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAllOffers¶

Example Request¶

Response¶

Example Response¶

POST /v3/getCustodianDetailsforOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getOfferingDetails¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getOfferingPurchaseHistory¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getOfferingStatus¶

Parameters¶

Example Request¶

Response¶

Example Response¶

GET /v3/offerings¶

Permissions¶

Authorization¶

Query Parameters¶

Filtering and Sorting¶

POST /v3/searchOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/updateOffering¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/updateOfferingDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

`POST /v3/cancelOffering`¶

`POST /v3/closeOffering`¶

`PUT /v3/createOffering`¶

`POST /v3/deleteOffering`¶

`POST /v3/getAllOffers`¶

`POST /v3/getCustodianDetailsforOffering`¶

`POST /v3/getOffering`¶

`POST /v3/getOfferingDetails`¶

`POST /v3/getOfferingPurchaseHistory`¶

`POST /v3/getOfferingStatus`¶

`GET /v3/offerings`¶

`POST /v3/searchOffering`¶

`POST /v3/updateOffering`¶

`POST /v3/updateOfferingDocument`¶