Issuers¶

All requests require clientID and developerAPIKey parameters for authentication.

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

Endpoints¶

PUT /v3/createIssuer
PUT /v3/createIssuerAccount
POST /v3/deleteIssuer
POST /v3/deleteIssuerAccount
POST /v3/getAllIssuers
POST /v3/getIssuer
POST /v3/getIssuerAccount
GET /v3/issuers
POST /v3/searchIssuer
POST /v3/updateIssuer
POST /v3/updateIssuerAccount

`PUT /v3/createIssuer`¶

This method is used to create an Issuer in Transact API. This method will return the Issuer ID as a successful response.

Parameters¶

Parameter	Type	Required	Description
`issuerName`	string	Yes	The name of the issuer.
`firstName`	string	Yes	The first name of the primary contact for the issuer.
`lastName`	string	Yes	The last name of the primary contact for the issuer.
`email`	string	Yes	The email address of the primary contact for the issuer.
`phoneNumber`	integer	No	The phone number of the primary contact for the issuer.
`createdIpAddress`	string	No	Created IP Address

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/createIssuer
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerName=JohnDeo
-d firstName=John
-d lastName=Deo
-d phoneNumber=4156985123
-d email=johndeo001@gmail.com
-d createdIpAddress=10.0.0.9

Response¶

Field	Type	Description
`issuerId`	integer	ID for the issuer
`issuerStatus`	string	Status of issuer - Approved \

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "issuerDetails": [
    true,
    [
      {
        "issuerId": "96763",
        "issuerStatus": "Pending"
      }
    ]
  ]
}

`PUT /v3/createIssuerAccount`¶

This method is used to create an issuer account. You will need to specify the Issuer ID(createIssuer) as a request parameter to create the issuer account information. This endpoint is optional for information storage purposes and has no other function.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	integer	Yes	Issuer ID that is generated by the API when an Issuer is created(createIssuer)
`accountType`	string	No	Type of account - CHECKING or SAVINGS
`companyName`	string	Yes	Legal name of the company
`companyState`	string	Yes	Company's state of registration (Use two-letter state abbreviation)
`entityType`	string	No	Entity Type ( LLC, LP, Corp, GP, Soleprop )
`companyTaxID`	integer	No	Company's employer tax ID, 9 digits with no hyphens
`accountMiddleInitial`	string	No	The Issuer's middle initial
`socialSecurityNumber`	string	No	The Issuer's SSN xxx-xx-xxxx
`dob`	string	No	The Issuer's DOB (MM-DD-YYYY)
`residentUS`	conditional	No	Yes or No. Is the issuer a U.S. resident?
`citizenUS`	conditional	No	Yes or No. Is the issuer a U.S. citizen?
`addressline1`	string	No	The Issuer's physical address, line 1
`addressline2`	string	No	The Issuer's physical address, line 2
`city`	string	No	The city of the Issuer's physical address
`zip`	string	No	The zip code of the Issuer's physical address
`country`	string	No	The country of the Issuer's physical address
`additionalInfo`	string	No	Additional information regarding to the Issuer
`createdIpAddress`	string	Yes	Requested IP Address
`issuingCountry`	string	Yes	The Issuer's physical address, issuing country

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/createIssuerAccount
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerId=652683
-d accountType=Checking
-d companyName=Ephron
-d companyState=GA
-d entityType=gp
-d companyTaxID=112-22-3333
-d accountMiddleInitial=R
-d socialSecurityNumber=112-22-3333
-d dob=1987-05-05
-d residentUS=yes
-d citizenUS=yes
-d addressline1=222333 PEACHTREE PLACE
-d addressline2=SUITE 43
-d city=ATLANTA
-d zip=30318
-d country=GA
-d issuingCountry=GA
-d additionalInfo=Text
-d createdIpAddress=10.0.0.9

Response¶

Field	Type	Description
`Financial Issuer Details`	string	Returns an array of issuer details ( issuerId, companyName, companyState, companyTaxID, entityType, issuingCountry, accountType, accountMiddleInitial, socialSecurityNumber, dob, residentUS, citizenUS, addressLine1, addressLine2, city, zip, country, additionalInfo, issuerStatus, createdDate, createdIpAddress )

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "Financial issuer details": {
    "1": [
      {
        "issuerId": "882512",
        "companyName": "US private limited",
        "companyState": "CA",
        "companyTaxID": "65896546654",
        "entityType": "llc",
        "issuingCountry": "USA",
        "accountType": "Saving",
        "accountMiddleInitial": "M",
        "socialSecurityNumber": "112-22-3333",
        "dob": "02-28-1975",
        "residentUS": "yes",
        "citizenUS": "yes",
        "addressLine1": "PEACH TREE",
        "addressLine2": "1st street",
        "city": "ATLANTA",
        "zip": "30318",
        "country": "USA",
        "additionalInfo": "Private concern",
        "issuerStatus": "Pending",
        "createdDate": "2014-11-26 04:05:50",
        "createdIpAddress": "10.0.0.114"
      }
    ]
  }
}

`POST /v3/deleteIssuer`¶

This method is used to delete a particular issuer from Transact API. The delete is a virtual delete. You will need to specify the Issuer ID as a request parameter to delete an issuer.

Parameters¶

Parameter	Type	Required	Description
`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/deleteIssuer
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerId=652683

Response¶

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Issuer deleted successfully!"
}

`POST /v3/deleteIssuerAccount`¶

This method is used to delete a particular Issuer financial account from Transact API. The delete is a virtual delete. You will need to specify the Issuer ID as a request parameter to delete the Issuer Financial Account.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	integer	Yes	Issuer ID that is generated by the API when an Issuer is created (createIssuer)
`CustName`	string	No	Name of the custodian

Example Request¶

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

Response¶

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Issuer Financial Account deleted successfully!"
}

`POST /v3/getAllIssuers`¶

Deprecated

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

Get all issuers for a given client

Example Request¶

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

Response¶

Field	Type	Description
`issuerDetails`	string	Get issuers details array

Example Response¶

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

`POST /v3/getIssuer`¶

This method is used to get information about an issuer. You will need to specify the Issuer ID as a request parameter to get the issuer information.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	string	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/getIssuer
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerId=652683

Response¶

Field	Type	Description
`issuerDetails`	string	Array of issuer details includes all information of the matched issuers (issuerId, issuerName, firstName, lastName, email, phoneNumber, issuerStatus)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "issuerDetails": [
    {
      "issuerId": "96763",
      "issuerName": "EphronSys",
      "firstName": "Ephron",
      "lastName": "Sys",
      "email": "ephronprabhu@gmail.com",
      "phoneNumber": null,
      "issuerStatus": "Pending"
    }
  ]
}

`POST /v3/getIssuerAccount`¶

This method is used to get information about the issuer account. You will need to specify the Issuer ID(createIssuer) as a request parameter to get the issuer account information.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	string	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/getIssuerAccount
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerId=564631

Response¶

Field	Type	Description
`issuerDetails`	string	Returns the issuer account details as an array

Example Response¶

{
    "statusCode": "101",
    "issuerId": "882512",
    "Financial issuer details": [
        {
            "CustodianName": "Sample",
            "CustodianAccountNumber": "363737398390",
            "RoutingNumber": "63838030303",
            "AccountNumber": "NC-882512",
            "AccountName": "john smith",
            "funds": "10000.00"
        },
        {
            "CustodianName": "Testing",
            "CustodianAccountNumber": "9868465646",
            "RoutingNumber": "123456789",
            "AccountNumber": "NC-882512",
            "AccountName": "JOHN SMITH",
            "funds": "4000.00"
        }
    ],
    "statusDesc": {
        "issuerId": "882512",
        "accountfirstName": JOHN,
        "accountlastName": SMITH,
        "accountType": "saving",
        "companyName": "ephsys",
        "companyState": "CA",
        "entityType": "llc",
        "companyTaxID": "7568567567",
        "accountMiddleInitial": "M",
        "socialSecurityNumber": "112-22-3333",
        "dob": "02-28-1975",
        "residentUS": "yes",
        "citizenUS": "yes",
        "addressLine1": PEACHTREE,
        "addressLine2": "PALACE",
        "city": ATLANTA,
        "zip": 30318,
        "country": "USA",
        "issuingCountry": "USA",
        "additionalInfo": "Issuer Text",
        "issuerAccountStatus": "approved"
    }
}

`GET /v3/issuers`¶

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

Permissions¶

This method requires the scope issuer.read.pii_medium 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 issuer in the list.
`limit`	integer	10	The maximum number of issuers to return. Max value is 500.
`deleted`	boolean	false	Include deleted issuers in response.
`filter`	string (JSON)		Filter results by specific fields.

Filtering¶

For more information see Working with List Endpoints.

`POST /v3/searchIssuer`¶

Deprecated

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

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

Parameters¶

Parameter	Type	Required	Description
`searchKeyword`	string	Yes	Keyword to search

Example Request¶

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

Response¶

Field	Type	Description
`issuerDetails`	string	Array of issuers includes all information of the matched issuers ( issuerId, issuerName, firstName, lastName, email, phoneNumber, issuerStatus )

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "issuerDetails": [
    {
      "issuerId": "654312",
      "issuerName": "ncissuer",
      "firstName": "john",
      "lastName": "issLNhxN",
      "email": "ncissuer198@yopmail.com",
      "phoneNumber": "1234567890",
      "issuerStatus": "approved"
    }
  ]
}

`POST /v3/updateIssuer`¶

This method is used to update a particular issuer in Transact API. You will need to specify the Issuer ID as a request parameter for the update to take place.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	integer	Yes	Issuer ID that is generated by the API when an Issuer is created (createIssuer)
`issuerName`	string	Yes	The name of the issuer.
`firstName`	string	Yes	The first name of the primary contact for the issuer.
`lastName`	string	Yes	The last name of the primary contact for the issuer.
`email`	string	Yes	The email address of the primary contact for the issuer.
`phoneNumber`	integer	No	The phone number of the primary contact for the issuer.
`issuerStatus`	conditional	No	Status: Approved \
`updatedIpAddress`	string	Yes	Requested IP Address

Example Request¶

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

Response¶

Field	Type	Description
`issuerId`	integer	ID for the issuer
`issuerStatus`	string	Status of issuer - Approved \

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "issuerDetails": [
    true,
    [
      {
        "issuerId": "96763",
        "issuerStatus": "Pending"
      }
    ]
  ]
}

`POST /v3/updateIssuerAccount`¶

This method is used to update an existing issuer account. You will need to specify the Issuer ID(createIssuer) as a request parameter to update the issuer account information.

Parameters¶

Parameter	Type	Required	Description
`issuerId`	integer	Yes	Issuer ID that is generated by the API when an Issuer is created(createIssuer)
`accountType`	string	No	Type of account - CHECKING or SAVINGS
`companyName`	string	Yes	Legal name of the company
`companyState`	string	Yes	Company's state of registration (Use two-letter state abbreviation)
`entityType`	string	No	Entity Type ( LLC, LP, Corp, GP, Soleprop )
`companyTaxID`	integer	No	Company's employer tax ID, 9 digits with no hyphens
`accountMiddleInitial`	string	No	The Issuer's middle initial
`socialSecurityNumber`	string	No	The Issuer's SSN xxx-xx-xxxx
`dob`	string	No	The Issuer's DOB (MM-DD-YYYY)
`residentUS`	conditional	No	Yes or No. Is the issuer a U.S. resident?
`citizenUS`	conditional	No	Yes or No. Is the issuer a U.S. citizen?
`addressline1`	string	No	The Issuer's physical address, line 1
`addressline2`	string	No	The Issuer's physical address, line 2
`city`	string	No	The city of the Issuer's physical address
`zip`	string	No	The zip code of the Issuer's physical address
`country`	string	No	The country of the Issuer's physical address
`additionalInfo`	string	No	Additional information regarding to the Issuer
`providerId`	integer	No	Custodian ID
`bankName`	string	No	Name of the bank
`bankRoutingNumber`	integer	No	Issuer's routing number
`accountNumber`	integer	No	Account number issued by the bank
`updatedIpAddress`	integer	Yes	Updated IP Address
`issuingCountry`	string	Yes	The Issuer's physical address, issuing country

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateIssuerAccount 
-d developerAPIKey=somedeveloperkey 
-d clientID=someclientid 
-d issuerId=652683 
-d accountType=Checking 
-d companyName=Ephron 
-d companyState=GA 
-d entityType=gp 
-d companyTaxID=112-22-3333 
-d accountMiddleInitial=R 
-d socialSecurityNumber=112-22-3333 
-d dob=1987-05-05 
-d residentUS=yes 
-d citizenUS=yes 
-d addressline1=222333 PEACHTREE PLACE 
-d addressline2=SUITE 43 
-d city=ATLANTA 
-d zip=30318 
-d country=GA 
-d issuingCountry=GA 
-d additionalInfo=Text 
-d createdIpAddress=10.0.0.9

Response¶

Field	Type	Description
`Financial Issuer Details`	string	Returns Success Response for an Issuer

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "Financial issuer details": {
    "1": [
      {
        "issuerId": "882512"
      }
    ]
  }
}

Issuers¶

Endpoints¶

PUT /v3/createIssuer¶

Parameters¶

Example Request¶

Response¶

Example Response¶

PUT /v3/createIssuerAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteIssuer¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteIssuerAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAllIssuers¶

Example Request¶

Response¶

Example Response¶

POST /v3/getIssuer¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getIssuerAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

GET /v3/issuers¶

Permissions¶

Authorization¶

Query Parameters¶

Filtering¶

POST /v3/searchIssuer¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/updateIssuer¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/updateIssuerAccount¶

Parameters¶

Example Request¶

Response¶

Example Response¶

`PUT /v3/createIssuer`¶

`PUT /v3/createIssuerAccount`¶

`POST /v3/deleteIssuer`¶

`POST /v3/deleteIssuerAccount`¶

`POST /v3/getAllIssuers`¶

`POST /v3/getIssuer`¶

`POST /v3/getIssuerAccount`¶

`GET /v3/issuers`¶

`POST /v3/searchIssuer`¶

`POST /v3/updateIssuer`¶

`POST /v3/updateIssuerAccount`¶