Accreditation Verification
All requests require clientID and developerAPIKey parameters for authentication.
Base URL: https://api-sandboxdash.norcapsecurities.com
Endpoints
POST /v3/getAiDocument
This method is used to retrieve a list of all accreditation documents associated with a specific account.
Parameters
| Parameter | Type | Required | Description |
accountId | string | Yes | Account ID that is generated by the API once an account is created (createAccount) |
documentId | string | No | Document Id generated by the 'uploadVerificationDocument' method |
Example Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAiDocument
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d accountId=A74413
-d documentId=SDrKb
Response
| Field | Type | Description |
document\_details | string | Array of verification document details associated with |
Example Response
{
"statusCode": "101",
"statusDesc": "Ok",
"document_details": [
{
"accountId": "A74413",
"documentid": "gHnhS",
"documentTitle": " Testing2",
"documentFileName": "GKrQ180918120031.pdf",
"documentFileReferenceCode": "180918120031",
"createdDate": "2018-09-18"
}
]
}
POST /v3/getAiLetter
This method is used to retrieve the letter verifying Accredited Investor (requestAiVerification) status for a specific account.
Parameters
| Parameter | Type | Required | Description |
accountId | string | Yes | Account ID that is generated by the API once an account is created (createAccount) |
Example Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAiLetter
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A77654
Response
| Field | Type | Description |
document\_details | string | Generates document details with account Id |
Example Response
{
"statusCode": "101",
"statusDesc": "Ok",
"document_details": {
"accountId": "A45510",
"documentUrl": "https://api-sandboxdash.norcapsecurities.com/tapiv3/uploads/aiLetter/aiVerifyDocumentA45510.pdf"
}
}
POST /v3/getAiRequest
This method is used to retrieve the status of an accreditation verification request (requestAiVerification) for a specific account.
Parameters
| Parameter | Type | Required | Description |
accountId | string | Yes | Account ID that is generated by the API once an account is created (createAccount) |
Example Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAiRequest
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A52991
Response
| Field | Type | Description |
accreditedDetails | string | Array of account accredited details |
Example Response
{
"statusCode": "101",
"statusDesc": "Ok",
"accreditedDetails": {
"request": [
{
"airequestId": "vvNlBU",
"accountId": "A11685",
"aiMethod": "Upload",
"allow": "Pending",
"aiDate": "0000-00-00",
"reviewedBy": "Testing",
"notes": "Test",
"aiRequestStatus": "Need More Info"
}
]
}
}
POST /v3/requestAiVerification
This is used to send a request to verify the accredited status of an Account (createAccount).*** This Method has fees associated with it that will be charged for each use. The cost to use this method is $35 per request. Fees will only be charged in the live environment. ***
Parameters
| Parameter | Type | Required | Description |
accountId | string | Yes | Account ID that is generated by the API once an account is created (createAccount) |
aiMethod | conditional | Yes | Accreditation method: Upload |
notes | string | No | Notes for request |
Example Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/requestAiVerification
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A12345
-d aiMethod=Upload
-d notes=Test
Response
| Field | Type | Description |
accreditedDetails | string | Array of account accredited details |
Example Response
{
"statusCode": "101",
"statusDesc": "Ok",
"accreditedDetails": [
{
"accountId": "A85479",
"aiRequestStatus": "Pending",
"airequestId": "6v7pDd",
"accreditedStatus": "Self Accredited"
}
]
}
POST /v3/updateAiRequest
This method is used to update the status of the submitted Accredited Investor verification request. This is normally used to indicate when new information has been uploaded by the investor and is ready for re-review in an existing review (New Info Added), or if an updated letter is being requested after a review was previously completed (Updated Letter Requested).
Parameters
| Parameter | Type | Required | Description |
airequestId | string | Yes | Request ID generated by the requestAiVerification method |
aiRequestStatus | string | Yes | Accreditation status: Updated Letter Requested or New Info Added |
Example Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/updateAiRequest
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d airequestId=lu16rk
-d aiRequestStatus=Approved
Response
| Field | Type | Description |
accreditedDetails | string | Array of account accredited details |
Example Response
{
"statusCode": "101",
"statusDesc": "Ok",
"accreditedDetails": [
{
"accountId": "A44683",
"aiRequestStatus": "New Info Added",
"airequestId": "lu16rK",
"accreditedStatus": "Verified Accredited"
}
]
}
POST /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.
Parameters
| Parameter | Type | Required | Description |
accountId | string | Yes | Account ID that is generated by the API when an account is created (createAccount) |
documentTitle | string | Yes | Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field |
userfile | string | Yes | Raw file data. Specification of raw file data is application specific. Accepted file types are PDF, JPG, PNG, HEIC and BMP. Minimum file size is 1 kB. Maximum file size is 100 MB. Please refer to the Sample Requests section for reference implementations. |
createdIpAddress | string | No | Requested IP Address |
Example Request
curl --location --request POST 'https://api-sandboxdash.norcapsecurities.com/v3/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'
Response
| Field | Type | Description |
document\_details | string | Document has been uploaded |
Errors(s) | string | (optional) provides more information about error response |