uploadVerificationDocument

POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/uploadVerificationDocument

This method is used to upload documentation to verify Accredited Investor status to a specific account. NCPS requires one of the three following options for accreditation verification: 1) W2's, 1099's or tax returns for the past two years to show your individual income exceeds $200,000 (or joint income exceeds $300,000) for each year. 2) Provide recent account statements or third party appraisals that show the value of your assets exceed $1,000,000 excluding your primary residence. (Must be dated within the last 3 months) 3) Provide an official written communication from any of the following stating that the professional service provider has a reasonable belief that you are an Accredited Investor (Must be dated within the last 3 months): A licensed CPA, Attorney, Investment Advisor, or Registered broker-dealer.
PDF, jpg, and png files are supported. Files cannot be larger than 100 MB.

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
accountId	yes	string	Account ID that is generated by the API when an account is created (createAccount)
documentTitle	yes	string	Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field
userfile	yes	string	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	no	string	Requested IP Address

Requirements

• File size: Files must be at least 1 kB and cannot exceed 100 MB.
• Accepted Formats: pdf, jpg, jpeg, and png.
• Content Type: The request must use multipart/form-data for proper file handling.
• Note: This endpoint uses userfile instead of userfile0 for the file parameter.
• A valid account ID is required; use the createAccount endpoint if the account does not exist.

Sample Requests

cURL

curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/uploadVerificationDocument' 
--form 'clientID=someclientid'
--form 'accountId=someaccountid'
--form 'createdIpAddress="127.0.0.1"' 
--form 'documentTitle="documentTitle0=Accreditation Verification Document"' 
--form 'userfile=@"/path/to/file"' 
--form 'developerAPIKey=somedeveloperAPIkey'

node:axios

import axios from 'axios';
import { Readable } from 'stream';
import FormData from 'form-data';

const apiHost = process.env.TAPI_HOST || 'https://api-sandboxdash.norcapsecurities.com';
const tapiUriSegment = 'tapiv3/index.php/v3';
const tapiUri = `${apiHost}/${tapiUriSegment}`;
const mimeType = 'application/json';

const tapi = axios.create({
  baseURL: tapiUri,
  timeout: 10000,
  headers: { accept: mimeType, 'content-type': mimeType },
});

const auth = {
  clientID: process.env.TAPI_CLIENT_ID,
  developerAPIKey: process.env.TAPI_API_KEY,
};

const uploadVerificationDocument = (accountId, file) => {
  const data = new FormData();
  data.append('clientID', auth.clientID);
  data.append('developerAPIKey', auth.developerAPIKey);
  data.append('accountId', accountId);
  data.append('documentTitle', `documentTitle0="${file.originalname}"`);
  data.append('userfile', Readable.from(file.buffer), { filename: file.originalname });
  data.append('createdIpAddress', '127.0.0.1');
  
  return tapi.post('/uploadVerificationDocument', data, {
    timeout: 60000,
    headers: { ...data.getHeaders() },
  });
};

const accountId = process.env.TAPI_ACCOUNT_ID;
const fakeFile = {
  buffer: Buffer.from('a'.repeat(1e3)),
  originalname: 'test-verification-file.pdf',
};

const response = await uploadVerificationDocument(accountId, fakeFile);

console.log(response.data);

/*
output:

{
  statusCode: '101',
  statusDesc: 'Ok',
  document_details: 'Document has been uploaded Successfully'
}
*/

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
document_details	string	Document has been uploaded
Errors(s)	string	(optional) provides more information about error response

Sample Response

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

Errors

HTTP response code	TAPI error code	Description
404	103	Invalid credentials
400	1400	Invalid content-type (must be multipart/form-data)
400	1400	No file data set in request
404	106	Invalid request parameters
404	106	accountId required but not provided
404	148	Account is not exist/active
422	1422	documentTitlemalformed
422	1422	userfilerequired but not provided
404	106	File content does not meet minimum byte size requirement (1 kilobyte)

Test it Yourself!