Parties¶

All requests require clientID and developerAPIKey parameters for authentication.

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

Status and enumerated fields

Fields such as domicile, KYCstatus/kycStatus, AMLstatus/amlStatus, empStatus, ownersAI, associatedPerson, and entityType are stored as free-form text. The values listed on this page are expected conventions; the API does not validate them and does not apply a default (an omitted field is stored empty).

Field casing

The KYC/AML status field names vary by method: createParty, updateParty, createEntity, and updateEntity return KYCstatus/AMLstatus; getParty and GET /v3/parties return kycStatus/amlStatus; getEntity and GET /v3/entities return KYCstatus/AMLstatus.

Endpoints¶

PUT /v3/createEntity
PUT /v3/createParty
POST /v3/deleteEntity
POST /v3/deleteEntityDocument
POST /v3/deleteParty
POST /v3/deletePartyDocument
GET /v3/entities
POST /v3/getAllParties
POST /v3/getEntity
POST /v3/getEntityDocument
POST /v3/getParty
POST /v3/getPartyDocument
GET /v3/parties
POST /v3/searchEntity
POST /v3/searchParty
POST /v3/updateEntity
POST /v3/updateParty
POST /v3/updatePartyEntityArchivestatus

`PUT /v3/createEntity`¶

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

Parameters¶

Parameter	Type	Required	Description
`domicile`	string	No	U.S. citizen / U.S. resident / non-resident
`entityName`	string	Yes	Name of the Entity
`entityType`	string	No	Revocable Trust, Irrevocable Trust, Limited Partnership, LLC, Corporation
`entityDesc`	string	No	Description of the entity
`ein`	string	No	The entity's Employer Identification number (EIN) or Individual Social Security Number if applicable
`primCountry`	string	Yes	The country in which the entity's primary physical address is located
`primAddress1`	string	Yes	The entity's primary physical address, Line 1
`primAddress2`	string	No	The entity's primary physical address, Line 2
`primCity`	string	Yes	The city in which the entity's primary physical address is located
`primState`	string	Yes	The state in which the entity’s physical address is located (must be the two letter abbreviated form). Use the value “NOUS” for addresses outside the United States.
`primZip`	string	Yes	The ZIP / postal code of the entity's primary physical address
`emailAddress`	string	Yes	Entity party's primary email address
`emailAddress2`	string	No	Entity party's secondary email address
`phone`	string	No	Entity party's primary phone number
`phone2`	string	No	Entity party's secondary phone number
`totalAssets`	integer	No	Total amount of the entity's assets
`ownersAI`	string	No	Yes or No. Are the owners/members of the entity accredited investors?
`KYCstatus`	string	No	Know Your Customer (KYC) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; no default is applied (stored empty if omitted)
`AMLstatus`	string	No	Anti-Money Laundering (AML) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; no default is applied (stored empty if omitted)
`AMLdate`	string	No	Date of the last Anti-Money Laundering (AML) status update
`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
`createdIpAddress`	string	Yes	IP Address associated with the createEntity method call
`notes`	string	No	Free form text for any notes that need to be added to the entity party
`formationDate`	date	No	Formation date for the entity

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/createEntity
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d domicile=U.S. citizen
 -d entityName=John
 -d entityType=LLC
 -d entityDesc=Description
 -d EIN=112223333
 -d primCountry=USA
 -d primAddress1=PEACHTREE PLACE
 -d primAddress2=PEACHTREE PLACE
 -d primCity=Atlanta
 -d primState=GA
 -d primZip=30318
 -d emailAddress=john@gmail.com
 -d emailAddress2=smith@gmail.com
 -d phone=11223364585
 -d phone2=565656565
 -d totalAssets=10c
 -d ownersAI=Yes
 -d KYCstatus=pending
 -d AMLstatus=pending
 -d AMLdate=03-15-2016
 -d tags=tags
 -d createdIpAddress=10.0.0.111
 -d notes=Notes Added
-d formationDate=07-25-2016

Response¶

Field	Type	Description
`entityDetails`	array	A two-element array. The first value (a boolean indicating the insert succeeded) should be ignored. The second value is an array with one element, the new entity created by this request. See details below

Field	Type	Description
`partyId`	string	Entity ID generated by the API once an entity party is created (prefixed `E`)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "entityDetails": [
    true,
    [
      {
        "partyId": "E12345"
      }
    ]
  ]
}

`PUT /v3/createParty`¶

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

Parameters¶

Parameter	Type	Required	Description
`domicile`	string	Yes	Is the party a U.S. Citizen, U.S. Resident, or non-resident
`firstName`	string	Yes	Party's First Name
`middleInitial`	string	No	Party's Middle Initial
`lastName`	string	Yes	Party's Last Name
`socialSecurityNumber`	string	No	The Party's Full SSN ( xxx-xx-xxxx )
`dob`	string	Yes	The Party's Date of Birth (MM-DD-YYYY)
`primCountry`	string	Yes	The country in which the Party's physical address resides
`primAddress1`	string	Yes	The Party's physical address, line 1
`primAddress2`	string	No	The Party's physical address, line 2
`primCity`	string	Yes	The city of the Party's physical address
`primState`	string	Yes	The state in which the party’s primary residence is located (must be two letter abbreviated form). Use the value “NOUS” for addresses outside the United States.
`primZip`	string	Yes	Zip code
`emailAddress`	string	Yes	Party's contact email address
`emailAddress2`	string	No	Party's contact email address
`phone`	string	No	Party's contact phone number
`phone2`	string	No	Party's contact phone number
`occupation`	string	No	Party's occupation
`associatedPerson`	string	No	Yes or No - Is the party associated with a broker dealer?
`empCountry`	string	No	Employer country
`empAddress1`	string	No	Employer address 1
`empAddress2`	string	No	Employer address 2
`empCity`	string	No	Employer city
`empState`	string	No	Employer state
`empZip`	string	No	Employer zip
`empName`	string	No	Employer name
`currentAnnIncome`	integer	No	Party's current annual income
`avgAnnIncome`	integer	No	Party's average income over the past 2 years
`currentHouseholdIncome`	integer	No	Party's household income
`avgHouseholdIncome`	integer	No	Party's average household income
`householdNetworth`	integer	No	Household net worth
`KYCstatus`	string	No	Know Your Customer (KYC) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; no default is applied (stored empty if omitted)
`AMLstatus`	string	No	Anti-Money Laundering (AML) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; no default is applied (stored empty if omitted)
`AMLdate`	string	No	Date of the last Anti-Money Laundering (AML) status update
`tags`	string	No	Up to 10 tags, comma separated. Generally completed in the Admin interface or with question-based tag generation
`createdIpAddress`	string	No	IP Address associated with the createParty method call
`notes`	string	No	Free form text for any notes that need to be added to the party
`empStatus`	string	No	Select any one employee status.(eg: Employed, Not Employed, Retired, Student)
`field1`	string	No	Additional information relating to the party. Custom Field 1
`field2`	string	No	Additional information relating to the party. Custom Field 2
`field3`	string	No	Additional information relating to the party. Custom Field 3
`invest_to`	string	No	0 - I will be investing for myself 1 - I will be investing on behalf of another person or entity"

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/v3/createParty
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d domicile=U.S. citizen
 -d firstName=John
 -d middleInitial=D
 -d lastName=Smith
 -d socialSecurityNumber=112-22-3333
 -d dob=03-24-1972
 -d primCountry=USA
 -d primAddress1=PEACHTREE PLACE
 -d primAddress2=PEACHTREE PLACE
 -d primCity=Atlanta
 -d primState=GA
 -d primZip=30318
 -d emailAddress=john@gmail.com
 -d emailAddress2=smith@gmail.com
 -d phone=9876543210
 -d phone2=0123456789
 -d occupation=Developer
 -d associatedPerson=No
 -d empStatus=Employed
 -d empName=Acme Inc
 -d currentAnnIncome=200000
 -d avgAnnIncome=200000
 -d currentHouseholdIncome=300000
 -d avgHouseholdIncome=400000
 -d householdNetworth=200000
 -d KYCstatus=Pending
 -d AMLstatus=Pending
 -d AMLdate=03-15-2016
 -d tags=tags
 -d createdIpAddress=10.0.0.111
 -d invest_to=0
 -d field1=some text
 -d field2=some text
 -d field3=some text
 -d notes=Notes Added

Response¶

Field	Type	Description
`partyDetails`	array	A two-element array. The first value (a boolean indicating the insert succeeded) 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
`partyId`	string	Party ID generated by the API once an individual party is created (createParty)
`KYCstatus`	string	Know Your Customer (KYC) status as stored: echoes the submitted value, or empty if not supplied
`AMLstatus`	string	Anti-Money Laundering (AML) status as stored: echoes the submitted value, or empty if not supplied

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": [
    true,
    [
      {
        "partyId": "P39944",
        "KYCstatus": "Pending",
        "AMLstatus": "Pending"
      }
    ]
  ]
}

`POST /v3/deleteEntity`¶

This method is used to delete a particular entity party. The entity Party ID must be specified as a request parameter to delete the entity party.

Parameters¶

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

Example Request¶

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

Response¶

Example Response¶

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

`POST /v3/deleteEntityDocument`¶

This method is used to delete a document from a particular Entity (uploadEntityDocument).

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Entity ID that is generated by the API once an individual Entity is created (createEntity)
`documentId`	string	Yes	Document Id generated at the time of the uploadEntityDocument API method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deleteEntityDocument
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d partyId=E27512
 -d documentId=SDrKb

Response¶

Field	Type	Description
`partyDocumentDetails`	string	Confirmation message; on success the value is `Document deleted successfully`

Example Response¶

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

`POST /v3/deleteParty`¶

This method is used to delete a particular individual party. The Party ID must be specified as a request parameter to delete the individual party.

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/deleteParty
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d partyId=P32126

Response¶

Example Response¶

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

`POST /v3/deletePartyDocument`¶

This method is used to delete a document from a particular party (uploadPartyDocument).

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API once an individual party is created (createParty)
`documentId`	string	Yes	Document Id generated at the time of the uploadPartyDocument API method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deletePartyDocument
 -d clientID=someclientid
 -d developerAPIKey=somedeveloperkey
 -d partyId=P27512
 -d documentId=SDrKb

Response¶

Field	Type	Description
`partyDocumentDetails`	string	Confirmation message; on success the value is `Document deleted successfully`

Example Response¶

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

`GET /v3/entities`¶

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

Permissions¶

This method requires the scope party.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 party in the list.
`limit`	integer	10	The maximum number of parties to return. Max value is 500.
`deleted`	boolean	false	Include deleted parties 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.

Response Fields¶

The response envelope contains an entities array and a pagination object. Each element of entities has the following fields.

Field	Type	Description
`partyId`	string	Unique identifier for the entity party (prefixed `E`)
`domicile`	string	U.S. citizen / U.S. resident / non-resident
`entityName`	string	Name of the entity
`entityType`	string	Entity type, e.g. revocable trust, irrevocable trust, limited partnership, LLC, corporation
`entityDesc`	string	Description of the entity
`ein`	string	The entity's Employer Identification Number (EIN)
`primCountry`	string	Country of the entity's primary physical address
`primAddress1`	string	Primary physical address, line 1
`primAddress2`	string	Primary physical address, line 2
`primCity`	string	City of the primary physical address
`primState`	string	State of the primary physical address (two-letter abbreviation; `NOUS` for non-U.S.)
`primZip`	string	ZIP / postal code of the primary physical address
`emailAddress`	string	Primary email address
`emailAddress2`	string	Secondary email address
`phone`	string	Primary phone number
`phone2`	string	Secondary phone number
`totalAssets`	string	Total amount of the entity's assets
`ownersAI`	string	Are the owners/members of the entity accredited investors? (`Yes` / `No`)
`KYCstatus`	string	Know Your Customer (KYC) status: Pending, Auto Approved, Manually Approved, Disapproved
`AMLstatus`	string	Anti-Money Laundering (AML) status: Pending, Auto Approved, Manually Approved, Disapproved
`AMLdate`	string	Date of the last AML status update
`tags`	string	Comma-separated tags
`notes`	string	Free-form notes
`esignStatus`	string	E-signature status for the entity
`documentKey`	string	Key referencing the entity's document set
`formationDate`	string	Formation date of the entity
`createdDate`	string	Date the entity record was created
`updatedDate`	string	Date the entity record was last updated
`partystatus`	string	Archive state derived from `archived_status`: `Active` or `Archived`
`clientId`	string	Owning client ID. Returned only when the request is authenticated with the master key

The pagination object contains:

Field	Type	Description
`totalRecords`	integer	Total number of entities matching the query
`startIndex`	integer	Zero-based index of the first record returned
`endIndex`	integer	Zero-based index of the last record returned

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "entities": [
    {
      "partyId": "E45632",
      "domicile": "U.S. citizen",
      "entityName": "Entity Name",
      "entityType": "revocable trust",
      "entityDesc": "Entity Description",
      "ein": "152152",
      "primCountry": "USA",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "emailAddress": "johnsmith@gmail.com",
      "emailAddress2": "johnsmith@norcapsecurities.com",
      "phone": "1234567890",
      "phone2": "2147483647",
      "totalAssets": "3",
      "ownersAI": "no",
      "KYCstatus": "Pending",
      "AMLstatus": "Pending",
      "AMLdate": "02-15-2016",
      "tags": "Tags",
      "notes": "Notes Added",
      "esignStatus": "Pending",
      "documentKey": "",
      "formationDate": "07-25-2016",
      "createdDate": "2022-10-19",
      "updatedDate": "2022-10-19",
      "partystatus": "Active"
    }
  ],
  "pagination": {
    "totalRecords": 1,
    "startIndex": 0,
    "endIndex": 0
  }
}

`POST /v3/getAllParties`¶

Deprecated

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

Get all parties for a given client. NOTICE after January 13 this endpoint will return a maximum of 500 records. Please migrate to /v3/parties which supports filtering and pagination.

Example Request¶

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

Response¶

Field	Type	Description
`partyDetails`	string	Get all party details array

Example Response¶

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

`POST /v3/getEntity`¶

This method is used to get information about an Entity Party. The entity Party ID is required as a request parameter to get the Entity Party information.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`entityDetails`	string	Array of entity includes all information of the matched entity

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "entityDetails": [
    {
      "partyId": "E12679",
      "domicile": "U.S. citizen",
      "entityName": "Entity Name",
      "entityType": "revocable trust",
      "entityDesc": "Entity Description",
      "ein": "152152",
      "primCountry": "USA",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "emailAddress": "johnsmith@gmail.com",
      "emailAddress2": "johnsmith@norcapsecurities.com",
      "phone": "1234567890",
      "phone2": "2147483647",
      "totalAssets": "3",
      "ownersAI": "no",
      "KYCstatus": "Pending",
      "AMLstatus": "Pending",
      "AMLdate": "02-15-2016",
      "tags": "Tags",
      "notes": "Notes Added",
      "esignStatus": "Pending",
      "documentKey": "",
      "formationDate": "07-25-2016",
      "createdDate": "2022-10-19",
      "updatedDate": "2022-10-19"
    }
  ]
}

`POST /v3/getEntityDocument`¶

This method is used to get all information about individual Entity document. The Entity ID must be specified as a request parameter to get the Entity information.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Entity ID that is generated by the API once an individual Entity is created (createEntity)
`documentId`	string	No	Document Id generated in the time of upload entity document API method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getEntityDocument
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=E79443
-d documentId=SDrKb

Response¶

Field	Type	Description
`partyDocumentDetails`	string	Get party document details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDocumentDetails": [
    {
      "id": "3030330",
      "entityid": "E39944",
      "documentid": "gHnhS",
      "documentTitle": " Testing2",
      "documentFileName": "GKrQ180918120031.pdf",
      "documentFileReferenceCode": "180918120031",
      "createdDate": "2020-01-28",
      "documentUrl": "https://api.norcapsecurities.com/admin_v3/Upload_documentation/uploadDocument/WUxxxxZ4UWtF"
    }
  ]
}

`POST /v3/getParty`¶

This method is used to get all information about an individual Party. The Party ID must be specified as a request parameter to get the party information.

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/getParty
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d partyId=P79443

Response¶

Field	Type	Description
`partyDetails`	string	List of party includes all information of the matched party (partyId, firstName, middleInitial, lastName, domicile, socialSecurityNumber, dob, primAddress1, primAddress2, primCity, primState, primZip, primCountry, emailAddress, emailAddress2, phone, phone2, occupation, associatedPerson, empStatus, empCountry, empName, empAddress1, empAddress2, empCity, empState, empZip, invest_to, currentAnnIncome, avgAnnIncome, currentHouseholdIncome, avgHouseholdIncome, householdNetworth, kycStatus, amlStatus, amlDate, tags, notes, esignStatus, documentKey, field1, field2, field3, createdDate, updatedDate)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": [
    {
      "partyId": "P79443",
      "firstName": "John",
      "middleInitial": "D",
      "lastName": "Smith",
      "domicile": "U.S. citizen",
      "socialSecurityNumber": "112-22-3333",
      "dob": "03-24-1972",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "primCountry": "USA",
      "emailAddress": "john@gmail.com",
      "emailAddress2": "smith@gmail.com",
      "phone": "9876543210",
      "phone2": "0123456789",
      "occupation": "DEVELOPER",
      "associatedPerson": "Yes",
      "empStatus": "Employed",
      "empCountry": "USA",
      "empName": "Acme Inc",
      "empAddress1": "PEACHTREE PLACE",
      "empAddress2": "PEACHTREE PLACE",
      "empCity": "Atlanta",
      "empState": "GA",
      "empZip": "30318",
      "invest_to": "0",
      "currentAnnIncome": "200000",
      "avgAnnIncome": "500000",
      "currentHouseholdIncome": "300000",
      "avgHouseholdIncome": "400000",
      "householdNetworth": "200000",
      "kycStatus": "Pending",
      "amlStatus": "Pending",
      "amlDate": "03-17-2016",
      "tags": "Tags Added",
      "notes": "Notes Added",
      "esignStatus": "Pending",
      "documentKey": "",
      "field1": "Account Field 1",
      "field2": "Account Field 2",
      "field3": "Account Field 3",
      "createdDate": "2022-10-19",
      "updatedDate": "2022-10-19"
    }
  ]
}

`POST /v3/getPartyDocument`¶

This method is used to get all information about individual Parties document. The Party ID must be specified as a request parameter to get the party information.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API once an individual party is created (createParty)
`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/getPartyDocument
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=P79443
-d documentId=SDrKb

Response¶

Field	Type	Description
`partyDocumentDetails`	string	Get party document details

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDocumentDetails": [
    {
      "id": "3030330",
      "partyid": "P20164795",
      "documentid": "SNCDL",
      "documentTitle": "45FFF6XXXXXXAE.jpeg",
      "documentFileName": "1TSVpxxxxxd4cP.jpeg",
      "documentFileReferenceCode": "13073445",
      "createdDate": "2022-10-19",
      "documentUrl": "https://api.norcapsecurities.com/admin_v3/Upload_documentation/uploadDocument/WUxxxxZ4UWtF"
    }
  ]
}

`GET /v3/parties`¶

Fetch a list of party (legal person) resources associated with this client. Parties are ordered by created date with the most recently created party at index zero.

Permissions¶

This method requires the scope party.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 party in the list.
`limit`	integer	10	The maximum number of parties to return. Max value is 500.
`deleted`	boolean	false	Include deleted parties 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.

Response Fields¶

The response envelope contains a parties array and a pagination object. Each element of parties has the following fields.

Field	Type	Description
`partyId`	string	Unique identifier for the party (prefixed `P`)
`firstName`	string	Party's first name
`middleInitial`	string	Party's middle initial
`lastName`	string	Party's last name
`domicile`	string	U.S. citizen / U.S. resident / non-resident
`socialSecurityNumber`	string	The party's full SSN, returned decrypted
`dob`	string	Party's date of birth (MM-DD-YYYY), returned decrypted
`primAddress1`	string	Physical address, line 1
`primAddress2`	string	Physical address, line 2
`primCity`	string	City of the physical address
`primState`	string	State of the physical address (two-letter abbreviation; `NOUS` for non-U.S.)
`primZip`	string	ZIP / postal code
`primCountry`	string	Country of the physical address
`emailAddress`	string	Primary email address
`emailAddress2`	string	Secondary email address
`phone`	string	Primary phone number
`phone2`	string	Secondary phone number
`occupation`	string	Party's occupation
`associatedPerson`	string	Is the party associated with a broker dealer? (`Yes` / `No`)
`empStatus`	string	Employment status, e.g. Employed, Not Employed, Retired, Student
`empName`	string	Employer name
`empCountry`	string	Employer country
`empAddress1`	string	Employer address, line 1
`empAddress2`	string	Employer address, line 2
`empCity`	string	Employer city
`empState`	string	Employer state
`empZip`	string	Employer ZIP
`invest_to`	string	`0` = investing for self, `1` = investing on behalf of another person or entity
`currentAnnIncome`	string	Current annual income
`avgAnnIncome`	string	Average annual income over the past 2 years
`currentHouseholdIncome`	string	Current household income
`avgHouseholdIncome`	string	Average household income
`householdNetworth`	string	Household net worth
`kycStatus`	string	Know Your Customer (KYC) status: Pending, Auto Approved, Manually Approved, Disapproved
`amlStatus`	string	Anti-Money Laundering (AML) status: Pending, Auto Approved, Manually Approved, Disapproved
`amlDate`	string	Date of the last AML status update
`tags`	string	Comma-separated tags
`notes`	string	Free-form notes
`esignStatus`	string	E-signature status for the party
`documentKey`	string	Key referencing the party's document set
`field1`	string	Custom field 1
`field2`	string	Custom field 2
`field3`	string	Custom field 3
`createdDate`	string	Date the party record was created
`updatedDate`	string	Date the party record was last updated
`partystatus`	string	Archive state derived from `archived_status`: `Active` or `Archived`
`clientId`	string	Owning client ID. Returned only when the request is authenticated with the master key

The pagination object contains:

Field	Type	Description
`totalRecords`	integer	Total number of parties matching the query
`startIndex`	integer	Zero-based index of the first record returned
`endIndex`	integer	Zero-based index of the last record returned

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "parties": [
    {
      "partyId": "P79443",
      "firstName": "John",
      "middleInitial": "D",
      "lastName": "Smith",
      "domicile": "U.S. citizen",
      "socialSecurityNumber": "112-22-3333",
      "dob": "03-24-1972",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "primCountry": "USA",
      "emailAddress": "john@gmail.com",
      "emailAddress2": "smith@gmail.com",
      "phone": "9876543210",
      "phone2": "0123456789",
      "occupation": "DEVELOPER",
      "associatedPerson": "Yes",
      "empStatus": "Employed",
      "empName": "Acme Inc",
      "empCountry": "USA",
      "empAddress1": "PEACHTREE PLACE",
      "empAddress2": "PEACHTREE PLACE",
      "empCity": "Atlanta",
      "empState": "GA",
      "empZip": "30318",
      "invest_to": "0",
      "currentAnnIncome": "200000",
      "avgAnnIncome": "500000",
      "currentHouseholdIncome": "300000",
      "avgHouseholdIncome": "400000",
      "householdNetworth": "200000",
      "kycStatus": "Pending",
      "amlStatus": "Pending",
      "amlDate": "03-17-2016",
      "tags": "Tags Added",
      "notes": "Notes Added",
      "esignStatus": "Pending",
      "documentKey": "",
      "field1": "Account Field 1",
      "field2": "Account Field 2",
      "field3": "Account Field 3",
      "createdDate": "2022-10-19",
      "updatedDate": "2022-10-19",
      "partystatus": "Active"
    }
  ],
  "pagination": {
    "totalRecords": 1,
    "startIndex": 0,
    "endIndex": 0
  }
}

`POST /v3/searchEntity`¶

This method is used to search all entity parties for a specific keyword within the party information and will return all matches for that keyword.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`entityDetails`	string	Array of entity includes all information of the matched entities

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "entityDetails": [
    {
      "partyId": "E45632",
      "domicile": "U.S. citizen",
      "entityName": "Entity Name",
      "entityType": "revocable trust",
      "entityDesc": "Entity Description",
      "ein": "152152",
      "primCountry": "USA",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "emailAddress": "johnsmith@gmail.com",
      "emailAddress2": "johnsmith@norcapsecurities.com",
      "phone": "1234567890",
      "phone2": "2147483647",
      "totalAssets": "3",
      "ownersAI": "no",
      "KYCstatus": "Pending",
      "AMLstatus": "Pending",
      "AMLdate": "02-15-2016",
      "tags": "Tags",
      "notes": "Notes Added"
    }
  ]
}

`POST /v3/searchParty`¶

This method is used to search all individual parties for a specific keyword within the party information and will return all matches for that keyword.

Parameters¶

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

Example Request¶

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

Response¶

Field	Type	Description
`partyDetails`	string	Array of party includes all information of the matched party( partyId, firstName, middleInitial, lastName, domicile, socialSecurityNumber, dob, primAddress1, primAddress2, primCity, primState, primZip, primCountry, emailAddress, emailAddress2, phone, phone2, occupation, associatedPerson, empCountry, empAddress1, empAddress2, empCity, empState, empZip, currentAnnIncome, avgAnnIncome, currentHouseholdIncome, avgHouseholdIncome, householdNetworth, kycStatus, amlStatus, amlDate, tags, notes)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": [
    {
      "partyId": "P45332",
      "firstName": "John",
      "middleInitial": "D",
      "lastName": "Smith",
      "domicile": "U.S. citizen",
      "socialSecurityNumber": "112-22-3333",
      "dob": "03-24-1972",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "primCountry": "USA",
      "emailAddress": "john@gmail.com",
      "emailAddress2": "smith@gmail.com",
      "phone": "9876543210",
      "phone2": "0123456789",
      "occupation": "DEVELOPER",
      "associatedPerson": "Yes",
      "empCountry": "USA",
      "empAddress1": "PEACHTREE PLACE",
      "empAddress2": "PEACHTREE PLACE",
      "empCity": "Atlanta",
      "empState": "GA",
      "empZip": "30318",
      "currentAnnIncome": "200000",
      "avgAnnIncome": "500000",
      "currentHouseholdIncome": "300000",
      "avgHouseholdIncome": "400000",
      "householdNetworth": "200000",
      "kycStatus": "Pending",
      "amlStatus": "Pending",
      "amlDate": "03-17-2016",
      "tags": "Tags Added",
      "notes": "Notes Added"
    }
  ]
}

`POST /v3/updateEntity`¶

This method is used to update fields related to a particular entity party record in Transact API. The entity Party ID must be specified as a request parameter to update the record.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Entity ID that is generated by the API once an entity party is created (createEntity), prefixed `E`
`domicile`	string	No	U.S. Domicile or non-U.S.
`entityName`	string	No	Name of the Entity
`entityType`	string	No	Revocable Trust, Irrevocable Trust, Limited Partnership, LLC, Corporation
`entityDesc`	string	No	Description of the entity
`ein`	string	No	The entity's Employer Identification number (EIN) or Individual Social Security Number if applicable
`primCountry`	string	No	The country in which the entity's primary physical address is located
`primAddress1`	string	No	The entity's primary physical address, Line 1
`primAddress2`	string	No	The entity's primary physical address, Line 2
`primCity`	string	No	The city in which the entity's primary physical address is located
`primState`	string	No	The state in which the entity’s physical address is located (must be the two letter abbreviated form). Use the value “NOUS” for addresses outside the United States.
`primZip`	string	No	The Zip / postal code of the entity's primary physical address
`emailAddress`	string	No	Entity party's primary email address
`emailAddress2`	string	No	Entity party's secondary email address
`phone`	string	No	Entity party's primary phone number
`phone2`	string	No	Entity party's secondary phone number
`totalAssets`	integer	No	Total amount of the entity's assets
`ownersAI`	string	No	Yes or No. Are the owners/members of the entity accredited investors?
`KYCstatus`	string	No	Know Your Customer (KYC) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; if omitted the stored value is unchanged
`AMLstatus`	string	No	Anti-Money Laundering (AML) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; if omitted the stored value is unchanged
`AMLdate`	string	No	Date of the last Anti-Money Laundering (AML) status update. Set automatically to the current date when a submitted `AMLstatus` differs from the stored value
`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 entity party
`updatedIpAddress`	string	Yes	IP address associated with the updateEntity method call

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateEntity
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d partyId=E48864
 -d domicile=U.S. domicile
 -d entityName=John
 -d entityType=LLC
 -d entityDesc=Description
 -d EIN=112223333
 -d primCountry=USA
 -d primAddress1=PEACHTREE PLACE
 -d primAddress2=PEACHTREE PLACE
 -d primCity=Atlanta
 -d primState=GA
 -d primZip=30318
 -d emailAddress=john@gmail.com
 -d emailAddress2=smith@gmail.com
 -d phone=11223364585
 -d phone2=565656565
 -d totalAssets=10c
 -d ownersAI=Yes
 -d KYCstatus=Pending
 -d AMLstatus=Pending
 -d AMLdate=03-15-2016
 -d tags=tags
 -d updatedIpAddress=10.0.0.111
 -d notes=Notes Added

Response¶

Field	Type	Description
`entityDetails`	array	A two-element array. The first value (a boolean indicating the update succeeded) should be ignored. The second value is an array with one element, the updated entity. See details below

Field	Type	Description
`partyId`	string	Entity ID that was updated (prefixed `E`)
`KYCstatus`	string	Know Your Customer (KYC) status as stored after the update
`AMLstatus`	string	Anti-Money Laundering (AML) status as stored after the update

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "entityDetails": [
    true,
    [
      {
        "partyId": "E48864",
        "KYCstatus": "Pending",
        "AMLstatus": "Pending"
      }
    ]
  ]
}

`POST /v3/updateParty`¶

This method is used to update fields related to a particular individual party record in Transact API. The Party ID must be specified as a request parameter to update the record.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID that is generated by the API when an individual party is created (createParty), prefixed `P`
`domicile`	string	No	Is the party a U.S. Citizen, U.S. Resident, or non-resident
`firstName`	string	No	Party's First Name
`middleInitial`	string	No	Party's Middle Initial
`lastName`	string	No	Party's Last Name
`socialSecurityNumber`	string	No	The Party's Full SSN ( xxx-xx-xxxx )
`dob`	string	No	The Party's Date of Birth (MM-DD-YYYY)
`primCountry`	string	No	The country in which the Party's physical address resides
`primAddress1`	string	No	The Party's physical address, line 1
`primAddress2`	string	No	The Party's physical address, line 2
`primCity`	string	No	The city of the Party's physical address
`primState`	string	No	The state in which the party’s primary residence is located (must be two letter abbreviated form). Use the value “NOUS” for addresses outside the United States.
`primZip`	string	No	Zip code
`emailAddress`	string	No	Party's contact email address
`emailAddress2`	string	No	Party's contact email address
`phone`	string	No	Party's contact phone number
`phone2`	string	No	Party's contact phone number
`occupation`	string	No	Party's occupation
`associatedPerson`	string	No	Yes or No - Is the party associated with a broker dealer?
`empCountry`	string	No	Employer country
`empAddress1`	string	No	Employer address 1
`empAddress2`	string	No	Employer address 2
`empCity`	string	No	Employer city
`empState`	string	No	Employer state
`empZip`	string	No	Employer zip
`empName`	string	No	Employer name
`invest_to`	string	No	0 - I will be investing for myself 1 - I will be investing on behalf of another person or entity"
`currentAnnIncome`	integer	No	Party's current annual income
`avgAnnIncome`	integer	No	Party's average income over the past 2 years
`currentHouseholdIncome`	integer	No	Party's household income
`avgHouseholdIncome`	integer	No	Party's average household income
`householdNetworth`	integer	No	Household net worth
`KYCstatus`	string	No	Know Your Customer (KYC) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; if omitted the stored value is unchanged
`AMLstatus`	string	No	Anti-Money Laundering (AML) status. Expected values: Pending, Auto Approved, Manually Approved, Disapproved. Not validated; if omitted the stored value is unchanged
`AMLdate`	string	No	Date of the last Anti-Money Laundering (AML) status update. Set automatically to the current date when a submitted `AMLstatus` differs from the stored value
`tags`	string	No	Up to 10 tags, comma separated. Generally completed in the Admin interface or with question-based tag generation
`updatedIpAddress`	string	No	IP Address associated with the updateParty method call
`notes`	string	No	Free form text for any notes that need to be added to the party
`empStatus`	string	No	Select any one employee status (eg: Employed, Not Employed, Retired, Student)
`field1`	string	No	Additional information relating to the party. Custom Field 1
`field2`	string	No	Additional information relating to the party. Custom Field 2
`field3`	string	No	Additional information relating to the party. Custom Field 3

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateParty
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d partyId=P98542
 -d domicile=U.S. citizen
 -d firstName=John
 -d middleInitial=D
 -d lastName=Smith
 -d socialSecurityNumber=112-22-3333
 -d dob=28-02-1975
 -d primCountry=USA
 -d primAddress1=PEACHTREE PLACE
 -d primAddress2=TREE PLACE
 -d primCity=Atlanta
 -d primState=GA
 -d primZip=30318
 -d emailAddress=john@gmail.com
 -d emailAddress2=johnsmith@gmail.com
 -d phone=11223364585
 -d phone2=9876543210
 -d occupation=Developer
 -d associatedPerson=Yes
 -d invest_to=0
 -d empStatus=Employed
 -d empName=Name
 -d empCountry=USA
 -d empAddress1=PEACHTREE PLACE
 -d empAddress2=PEACHTREE PLACE
 -d empCity=Atlanta
 -d empState=GA
 -d empZip=30318
 -d currentAnnIncome=200000
 -d avgAnnIncome=200000
 -d currentHouseholdIncome=200000
 -d avgHouseholdIncome=200000
 -d householdNetworth=200000
 -d KYCstatus=Pending
 -d AMLstatus=Pending
 -d AMLdate=02-15-2016
 -d tags=tags
 -d updatedIpAddress=10.0.0.111
 -d field1=some text
 -d field2=some text
 -d field3=some text
 -d notes=Notes Added

Response¶

Field	Type	Description
`partyDetails`	array	A two-element array. The first value (a boolean indicating the update succeeded) should be ignored. The second value is an array with one element, the updated party. See details below

Field	Type	Description
`partyId`	string	Party ID that was updated (prefixed `P`)
`KYCstatus`	string	Know Your Customer (KYC) status as stored after the update
`AMLstatus`	string	Anti-Money Laundering (AML) status as stored after the update

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": [
    true,
    [
      {
        "partyId": "P39944",
        "KYCstatus": "Pending",
        "AMLstatus": "Pending"
      }
    ]
  ]
}

`POST /v3/updatePartyEntityArchivestatus`¶

Update the archive status of a party or entity. The same endpoint handles both individual parties and entities; the supplied partyId is matched against party records first and, if not found there, against entity records.

Parameters¶

Parameter	Type	Required	Description
`partyId`	string	Yes	Party ID or Entity ID generated by the API
`archiveStatus`	string	Yes	New archive state: `1` to archive, `0` to make active

Example Request¶

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

Response¶

Field	Type	Description
`partyDetails`	array	Array with one element describing the updated record. See fields below

Field	Type	Description
`partyId`	string	Party ID or Entity ID that was updated
`archiveStatus`	string	The resulting archive state: `0` (Active) or `1` (Archived)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "partyDetails": [
    {
      "partyId": "P12345",
      "archiveStatus": "1"
    }
  ]
}

Parties¶

Endpoints¶

PUT /v3/createEntity¶

Parameters¶

Example Request¶

Response¶

Example Response¶

PUT /v3/createParty¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteEntity¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteEntityDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deleteParty¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/deletePartyDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

GET /v3/entities¶

Permissions¶

Authorization¶

Query Parameters¶

Filtering and Sorting¶

Response Fields¶

Example Response¶

POST /v3/getAllParties¶

Example Request¶

Response¶

Example Response¶

POST /v3/getEntity¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getEntityDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getParty¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getPartyDocument¶

Parameters¶

Example Request¶

Response¶

Example Response¶

GET /v3/parties¶

Permissions¶

Authorization¶

Query Parameters¶

Filtering and Sorting¶

Response Fields¶

Example Response¶

POST /v3/searchEntity¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/searchParty¶

Parameters¶

Example Request¶

Response¶

Example Response¶

`PUT /v3/createEntity`¶

`PUT /v3/createParty`¶

`POST /v3/deleteEntity`¶

`POST /v3/deleteEntityDocument`¶

`POST /v3/deleteParty`¶

`POST /v3/deletePartyDocument`¶

`GET /v3/entities`¶

`POST /v3/getAllParties`¶

`POST /v3/getEntity`¶

`POST /v3/getEntityDocument`¶

`POST /v3/getParty`¶

`POST /v3/getPartyDocument`¶

`GET /v3/parties`¶

`POST /v3/searchEntity`¶

`POST /v3/searchParty`¶

`POST /v3/updateEntity`¶

`POST /v3/updateParty`¶

`POST /v3/updatePartyEntityArchivestatus`¶