LITE API

Please contact us at accounts@verifyinvestor.com for access to the LITE API, even if you already have access to the Regular API.

This base URL for this version of the API is at https://www.verifyinvestor.com/api/lite/v1.

List Verification Methods

This endpoint returns all available verification methods and descriptions for them. NOTE: The associated ID may be different between staging and production servers, so be sure to pull them dynamically and cache the results in your system. A verification method is required when creating a verification request.

Verification method IDs may vary between staging and production

Successful CURL request

curl -X GET "https://www.verifyinvestor.com/api/lite/v1/verification_requests/verification_methods"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example response for a successful response:

{
    "meta": "Verification methods pulled.",
    "data": [
        {
            "id": 9,
            "short_description": "All Owners Accredited",
            "type": "Entity",
            "description_for_lite": "An entity in which all the equity owners are accredited investors."
        }
    ]
}

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests/verification_methods

Response Code	Meaning
`200 Created`	The verification methods are returned
`403 Forbidden`	Request couldn't be processed, likely due to an incorrect token

Qualified Purchaser and Qualified Client

If enabled on your account, you can pull applicable verification methods by adding a type parameter to the query string with the value "qp" or "qc" as shown below.

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests/verification_methods?type=qp

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests/verification_methods?type=qc

List Verification Requests

This endpoint returns all of the Verification Requests issued by the API User.

Successful CURL request

curl -X GET "https://www.verifyinvestor.com/api/lite/v1/verification_requests/"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example response for a successful response:

{
    "meta": "Lite verification requests pulled.",
    "data": []
}

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests

Response Code	Meaning
`200 Created`	The verification methods are returned
`403 Forbidden`	Request couldn't be processed, likely due to an incorrect token

Create a Verification Request

This endpoint allows an API user to create a verification request. The VR is not submitted for review until it is submitted explicitly below.

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "email" : "john.smith@example.com",
        "verification_method_id" : 42,
        "legal_name": "John Smith",
        "portal_name": "Portal Name"
        "deal_name": "Investment Deal"
        "webhook_url" : "https://mywebsite.com/webhook"
     }'

Example response for a successful response:

{
    "meta": "Verification request created.",
    "data": {}
}

Example error when requesting a verification request:

{
    "meta": "Missing verification method.",
    "errors": [
        "Verification method ID is missing or invalid."
    ]
}

Example error when a verification request is already in progress:

{
    "errors": [
        "A pending verification request already exists."
    ],
    "data": {}
}

POST https://www.verifyinvestor.com/api/lite/v1/verification_requests

Parameter	Description
legal_name	Legal name of the investor
email	Email of the investor, this will be the email the investor uses to log in
verification_method_id	ID of the verification request method used. You can pull the full list of verification methods detailed above.
portal_name	(optional) The name of the investment portal
deal_name	(optional) The name of the specific investment deal
webhook_url	(optional) If you pass a webhook url, webhooks will POST to that url for this specific verification request. You must have an account webhook url set as default for this to work. If this is not set, webhooks will post to your account setting.

Response Code	Meaning
`201 Created`	The verification request is successfully created
`403 Forbidden`	Request couldn't be processed, likely due to an incorrect token
`422 Error`	Request couldn't be processed, likely due to incorrect params or a pre-existing verification request

Instant Verification

Example response when a verification request is instantly verified with the income method

{
    "meta": "Verification request created and auto verified with the income method based on verification request 359.",
    "data": {}
}

Example response when a verification request is instantly verified with the same date

{
    "meta": "Verification request created and auto verified with the same expiration date (3/24/2023) as verification request 423.",
    "data": {}
}

If the investor has been previously verified as an accredited investor using the Income method within the current calendar year, the verification request will be instantly verified upon creation as long as income evidence was provided for the most recent tax year for the previously verified request and the investor's email and legal name match. Verification requests can also be instantly verified by applying the same expiration date as the original verification request regardless of which method was used, but only if the following parameter is sent in the body of the request.

Parameter	Possible Values
auto_same_date	1-90 (days before expiration of original verification request)

If a verification request is instantly verified, no further action is required.

Qualified Purchaser and Qualified Client

If enabled on your account, you can create these types of verification requests by adding an additional parameter to the body of the request as shown below. Once the verification request is created, all other endpoints may be used without modification.

Parameter	Possible Values
type	`qp` or `qc`

Net Worth

If you choose to verify the investor with the Net Worth method, the following endpoints are required to facilitate the process and match how it is done on VerifyInvestor.com. This is optional for integrations created before 3/5/2024.

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/assets"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "name" : "Fidelity",
        "value" : 352489.63,
        "type" : "brokerage_account"
     }'

Create an Asset

POST /api/lite/v1/verification_requests/:id/assets

Parameter	Description
name	The name of the asset
value	The value of the asset in USD
type	The asset type (`bank_account`, `brokerage_account`, `vehicle`, `property`, `crypto`, or `other`)

Successful CURL request

curl -X PATCH "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:vr_id/assets/:id"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "value" : 245639.54
     }'

Edit an asset

Editing an existing asset takes the same parameters as creating an asset, but only one is required.

PATCH /api/lite/v1/verification_requests/:vr_id/assets/:id

Delete an asset

Deleting an asset takes no parameters.

DELETE /api/lite/v1/verification_requests/:vr_id/assets/:id

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/liabilities"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "name" : "Visa",
        "owed" : 2543.85,
        "type" : "credit_card",
        "on_credit_report" : true
     }'

Create a Liability

POST /api/lite/v1/verification_requests/:id/liabilities

Parameter	Description
name	The name of the liability
owed	How much is owed in USD
type	The liability type (`loan`, `credit_card`, `mortgage`, or `other`)
on_credit_report	Is this liability is listed on the investor's credit report? (`yes`, `no`, `true`, or `false`)

Successful CURL request

curl -X PATCH "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:vr_id/liability/:id"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "owed" : 7485.27
     }'

Edit a liability

Editing an existing liability takes the same parameters as creating an liability, but only one is required.

PATCH /api/lite/v1/verification_requests/:vr_id/liability/:id

Delete a liability

Deleting a liability takes no parameters.

DELETE /api/lite/v1/verification_requests/:vr_id/liability/:id

Succesful CURL request

curl -X PATCH "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/primary_residence"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "value : 750000,
        "debt" : 458950.17,
        "debt_last_sixty_days" : 35000
     }'

Set primary residence values

PATCH /api/lite/v1/verification_requests/:id/primary_residence

At least one of the following parameters is required.

Parameter	Description
value	The value the investor's primary residence in USD
debt	Total amount owed on the primary residence in USD
debt_last_sixty_days	Any debt on the primary residence accrued within the last 60 days in USD

Create a Verification Request Document

Successful CURL request

curl -X POST --header 'Content-Type: multipart/form-data' \
--header 'Accept: application/json' \
--header 'Authorization: Token XXX' \
-F 'document=@/Users/investor/Downloads/tax_return.jpeg;type=image/jpeg'
'https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/documents/?document_name=yoyo4&asset_id=23'

This endpoint adds a document to a verification request. A document could be, for instance, a PDF of recent tax returns

POST https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/documents

Net Worth

When verifying with the Net Worth method, an additional parameter is available to associate the document with a specific asset. Note that all assets must have at least one document associated with them prior to submitting the verification request. The asset_id is available in the response when you create asset or when you check the status of the verification request.

POST https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/documents?asset_id=23

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:vr_id/documents/:id/attach_to_asset"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "asset_id" : "23",
     }'

Parameter	Description
asset_id	The ID of the asset

You can also associate an asset with a previously uploaded document with the following endpoint. This endpoint also accepts the asset_id parameter

PATCH /api/lite/v1/verification_requests/:vr_id/documents/:id/attach_to_asset

Create a Verification Request Note

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/notes"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "note" : "This is Investor 42",
     }'

Example error when requesting a verification request:

{
    "meta": "Missing verification request.",
    "errors": [
        "No verification request found."
    ]
}

This endpoint creates a verification request note.

POST https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/notes

Parameter	Description
note	Text of the note itself

Delete a Verification Request Note

Successful CURL request

curl -X DELETE "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/note/:note_id"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \

This endpoint allows you delete a note that has not been submitted to the reviewing attorney.

DELETE https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/note/:note_id

Modify a Verification Request Note

Successful CURL request

curl -X PATCH "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/note/:note_id"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "note" : "This is the new text for the existing note",
     }'

This endpoint allows you to edit an existing note that has not yet been submitted to the reviewing attorney.

PATCH https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/note/:note_id

Parameter	Description
note	The new text for the existing note

Pull a TransUnion Credit Report

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/pull_credit_report"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "first_name" : "Jimmy",
        "middle_name" : "E",
        "last_name" : "Ortiz",
        "address" : "1954 POB 1954",
        "city" : "Traverse City",
        "state" : "MI",
        "zip_code" : "49685",
        "ssn" : "666224545",
        "dob" : "1988-07-05"
     }'

Net Worth verification requires a credit report to verify the investor's liabilities. You can either use the document endpoint to upload a credit report provided to you by the investor, or you can use this endpoint to pull a credit report from TransUnion on the investor's behalf. A truncated version of the investor's credit report containing only liability information will be transferred to us directly from TransUnion to be used by the reviewing attorney to confirm liability information. You will receive confirmation of a successful pull, but you cannot view the actual contents due to our agreement with TransUnion. This optional service is provided for your convenience and a small charge will be added to your monthly bill for each pull. Contact accounts@verifyinvestor.com for pricing information.

POST https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/pull_credit_report

Success response

{
  "meta" : "Credit report pulled successfully",
  "data" : [
    "TransUnion credit report for JIMMY E ORTIZ pulled successfully."
  ]
}

Error response: record not found

{
  "meta" : "Record not found",
  "errors" : [
    "The information provided does not match any records found in TransUnion's database."
   ]
}

Error response: account locked

{
  "meta" : "TransUnion account locked or frozen",
  "errors" : [
    "The TransUnion account is locked or frozen. It must be unlocked by its owner to allow 3rd-party pulls."
   ]
}

Error response: not available

{
  "meta" : "TransUnion not available",
  "errors" : [
    "The TransUnion site is inaccessible. Please try again later."
   ]
}

Parameter	Description
first_name	The investor's first name
last_name	The investor's last name
middle_name	(optional) The investor's middle name or middle initial
address	The investor's current street address
city	The investor's current city
state	The investor's current state
zip_code	The investor's current zip code
ssn	The investor's social security number
dob	(optional) The investor's date of birth (yyyy-mm-dd format)

Test Data (staging server only)

{
  "first_name" : "Jimmy",
  "last_name" : "Ortiz",
  "address" : "1954 POB 1954",
  "city" : "Traverse City",
  "state" : "MI",
  "zip_code" : "49685",
  "ssn" : "666224545"
}

{
  "first_name" : "Lynn",
  "last_name" : "Baxter",
  "address" : "114 Broadway",
  "city" : "Nyack",
  "state" : "NY",
  "zip_code" : "10960",
  "ssn" : "666221163"
}

Test Data

The following test data may be used to simlate a successful pull on our staging server.

Test Subject 1

Parameter	Value
first_name	Jimmy
last_name	Ortiz
address	1954 POB 1954
city	Traverse City
state	MI
zip_code	49685
ssn	666224545

Test Subject 2

Parameter	Value
first_name	Lynn
last_name	Baxter
address	114 Broadway
city	Nyack
state	NY
zip_code	10960
ssn	666221163

Change Verification Method on Verification Request

This endpoint allows a LITE API user to change the verification method on a verification request.

Successful CURL request

curl -X PATCH "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/change_verification_method"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "verification_method_id" : 42,
     }'

PATCH https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/change_verification_method

Response Code	Meaning
`204 No Content`	Verification request updated
`404 Not Found`	Verification Request does not exist, or has not authorized your application
`403 Forbidden`	Request couldn't be processed, likely due to a pending verification request or unauthorized portal name
`422 Unprocessable Entity`	Request couldn't be submitted, due to, for example, the VR is in a locked state

Submit Verification Request for Review

This endpoint submits a verification request for review.

Successful CURL request

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/submit"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

POST https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/submit

Response Code	Meaning
`201 Created`	Verification request created
`404 Not Found`	Verification Request does not exist, or has not authorized your application
`403 Forbidden`	Request couldn't be processed, likely due to a pending verification request or unauthorized portal name
`422 Unprocessable Entity`	Request couldn't be submitted, due to, for example a problem with the underlying VR

Net Worth

The Net Worth method has additional requirements if you integrated LITE API after 3/5/2024. You must create at least one asset, each asset must have at least one associated document, and assets minus liabilities must total at least $1M USD for accredited investor verifications or $2.2M USD for qualified client verifications, excluding the primary residence. Submission will be blocked if these requirements are not met. See the Net Worth section of Create a Verification Request and Create a Verification Request Document for more details.

Simulate Investor Completion of a Verification Request (staging server only)

This endpoint takes a Verification Request and simulates an investor filling out his or her information so that the verification request is then waiting for review.

Successful response answer

{
  "id": 1,
  "dashboard_status": "accepted-by-investor",
  "investor": {
    "id": 2,
    "verification_status": "unverified"
  }
}

Example error when simulating a review:

{
  "error": "Incorrect or missing params provided."
}

POST /api/lite/v1/verification_requests/:id/simulate_investor_completion

Response Code	Meaning
`200 OK`	Verification request simulation has occurred
`403 Unauthorized`	Unauthorized error, usually caused if the token does not have proper access
`422 Unprocessable Entity`	Wrong params error, usually caused if the verification request is not currently in the `waiting-for-investor-acceptance` state

Simulated Review (staging server only)

Simulate a review as accredited:

curl -X POST "https://www.verifyinvestor.com/api/lite/v1/verification_requests/90/review" \
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "status" : "need_more_information"
      }'

Example response for a success review:

{
  "id":135,
  "status" : "accredited",
  "legal_name" : "LEGAL NAME 1",
  "dashboard_status" : "accredited", #Deprecated
  "investor":
    {
      "id":90,
      "verification_status":"verified" #Deprecated
    }
}

Example error when simulating a review:

{
  "error": "Incorrect or missing params provided."
}

POST /api/lite/v1/verification_requests/:verification_request_id/review

Automatically reviews a verification request completed by an investor. The verification request must be in a way "waiting-for-review" status. The verification_request_id is the id returned when creating a new verification request.

Parameter	Description
status	Please provide one of the following: `accredited`, `not_accredited`, `need_more_information`.

Response Code	Meaning
`201 Created`	Verification request review succeeded
`404 Not Found`	User does not exist, or has not authorized your application
`403 Forbidden`	Request couldn't be processed, likely due to an incorrect status being passed or the verification request has not been completed by the investor

Get a Verification Request

This endpoint returns the Verification Request by its ID. If no Verification Request is found, it returns an error.

Successful CURL request

curl -X GET "https://www.verifyinvestor.com/api/lite/v1/verification_requests/1"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example response for a successful response:

{
  "meta": "Verification request pulled.",
  "data": {
    "id": 1,
    "created_at": "2022-08-11T15:15:49.660-07:00",
    "completed_at": null,
    "waiting_for_info": true,
    "verified_expires_at": null,
    "webhook_url": null,
    "verification_request_step": "waiting_for_information_from_investor",
    "notes_from_reviewer": [
      {
        "time": "2022-09-26T14:22:41.974-07:00",
        "note": "<p>Please provide evidence of assets.</p> "
      }
    ],
    "notes": [],
    "investor": {
      "legal_name": "INVESTOR NAME"
    },
    "documents": [
      {
        "id": 1,
        "asset_content_type": "application/pdf",
        "name": "sample.pdf"
      },
      {
        "id": 2,
        "asset_content_type": "image/jpeg",
        "name": "sample.jpg"
      }
    ],
    "verification_method": {
      "id": 1
    }
  }
}

Example error when requesting a verification request:

{
    "meta": "Missing verification request.",
    "errors": [
        "No verification request found."
    ]
}

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id

Response Code	Meaning
`200 Created`	The verification methods are returned
`403 Forbidden`	Request couldn't be processed, likely due to an incorrect token

Reviewer Notes

Please note the notes_from_reviewer field in the sample response shown on the right. If the reviewer requires additional information, it will be detailed in this field. The reviewer notes may also contain HTML tags that can be rendered to format the notes the way the reviewer intended.

To provide the requested information you can upload documents with the documents endpoint, provide notes to the reviewer with the notes endpoint, and then resubmit using the submit endpoint. If requested, you can also change the verification method with the change verification method endpoint

Get Verification Requests

This endpoint returns all verification_requests by default, or verification requests matching the criteria you set.

Successful CURL request

curl -X GET "https://www.verifyinvestor.com/api/lite/v1/verification_requests?from_date=2022-08-01&to_date=2022-08-31&status=waiting_for_information_from_investor"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example response for a successful response:

[
  {
    "meta": "Verification request pulled.",
    "data": {
      "id": 1,
      "created_at": "2022-08-11T15:15:49.660-07:00",
      "completed_at": null,
      "waiting_for_info": true,
      "verified_expires_at": null,
      "webhook_url": null,
      "verification_request_step": "waiting_for_information_from_investor",
      "notes_from_reviewer": [
        {
          "time": "2022-09-26T14:22:41.974-07:00",
          "note": "<p>Please provide evidence of assets.</p> "
        }
      ],
      "notes": [],
      "investor": {
        "legal_name": "INVESTOR NAME"
      },
      "documents": [
        {
          "id": 1,
          "asset_content_type": "application/pdf",
          "name": "sample.pdf"
        },
        {
          "id": 2,
          "asset_content_type": "image/jpeg",
          "name": "sample.jpg"
        }
      ],
      "verification_method": {
        "id": 1
      }
    }
  }
]

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests

Query Parameters (optional)

The following may be added as optional query parameters to filter which verification requests are returned.

Parameter	Description
from_date	The beginning of the date range (yyyy-mm-dd format) of the creation of the verification requests.
to_date	The end of the date range (inclusive, yyyy-mm-dd format) of the creation of the verification requests.
status	The current status of the verification requests. See a list of possible statuses below.

Verification Request Statuses

The following are the only statuses available through LITE API. Other statuses are possible for verification requests created through our website or our other API options. A complete list is available in our Regular API docs.

Status	Explanation
`accepted_by_investor`	This is the initial state for verification requests created through LITE API.
`waiting_for_review`	The verification request has been submitted and is now in the reviewers' queue.
`in_review`	The verification request has been assigned a reviewer and is under review.
`accredited`	The investor is verified as accredited.
`not_accredited`	After review, it appears the investor is not accredited.
`waiting_for_information_from_investor`	The reviewer has requested additional information from the investor.

Get a Verification Request Document

This endpoint retrieves a document relevant to a Verification request

Successful CURL request

curl -X GET "https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/documents/:document_id"
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/documents/:id

Query Parameters

Parameter	Description
document_name	The name of the document to be saved to the VR
document	Formdata of the document file itself

Response Code	Meaning
`201 Created`	Verification request document created
`404 Not Found`	Verification Request does not exist, or has not authorized your application
`403 Forbidden`	Request couldn't be processed, likely due to a pending verification request or unauthorized portal name
`422 Unprocessable Entity`	Request couldn't be submitted, due to, for example, an invalid `document`

Destroy a Verification Request Document

This endpoint destroys a document from a pending verification request

DELETE https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/documents/:id

Get a Verification Request Certificate

This endpoint retrieves a verification request certificate about a completed verification request. These documents are what we use to certify that an investor has been reviewed.

GET https://www.verifyinvestor.com/api/lite/v1/verification_requests/:id/verification_certificate

Response Code	Meaning
`200 OK`	Verification request certificate returned
`404 Not Found`	Verification Request does not exist, or has not authorized your application

Webhooks

Example webhook body:

{
  "action": "verification_result",
  "verification_request_id": 90,
  "legal_name": "Legal Name 1",
  "status" : "not_accredited"
}

Example webhook body:

{
  "action": "verification_result",
  "verification_request_id": 90,
  "legal_name": "Legal Name 1",
  "status" : "accredited"
  "verified_expires_at" : "2023-05-24"
}

If you specify a "WebHook URL" under your account Settings, VerifyInvestor.com will submit a POST request to that URL when a reviewer makes a determination that an investor is accredited, not accredited, or more information is required to complete the verification request. Webhooks are NOT guaranteed delivery and should not be relied on. Please make sure to regularly check the verification request status to ensure you have the latest accurate information.

After receiving this WebHook, you can perform actions within your system, such as downloading the investor's verification certificate. Please see the certificates endpoint endpoint for more information.

Webhook Request

Manually fire a webhook:

curl "https://www.verifyinvestor.com/api/lite/v1/verification_requests/90/webhook" \
  -H "Authorization: Token YOUR_API_TOKEN_HERE"

Example response for a success webhook request:

{
  "action": "verification_result",
  "verification_request_id": 90,
  "investor_id": 135,
  "status" : "waiting_for_information_from_investor",
}

Example error when requesting a webhook:

{
  "error": "A verification request could not be found."
}

GET /api/lite/v1/verification_requests/:id/webhook

This manually fires a webhook to return the current state of the verification request. The id is the id returned when creating a new verification request.

Response Code	Meaning
`200 OK`	Webhook request succeeded
`404 Not Found`	The `id` parameter does not match one of your verification requests
`403 Forbidden`	Request could not be processed because your API token is incorrect or LITE API is not enabled on your account

Billing

Pull verification request counts for for billing purposes:

curl -X GET "https://www.verifyinvestor.com/api/v1/billing?from_date=2023-01-01&to_date=2023-01-31" \
  -H "Authorization: Token YOUR_API_TOKEN_HERE" \
  -H "Accept: application/json" \

Sample response with only LITE API enabled:

{
  "from_date": "2023-01-01",
  "to_date": "2023-01-31",
  "lite": 23,
  "transunion_credit_reports": {
    "successful": 2,
    "total": 3
  }
}

Sample response with all API types enabled:

{
  "from_date": "2023-01-01",
  "to_date": "2023-01-31",
  "regular": 5,
  "lite": 23,
  "embedded": 9,
  "transunion_credit_reports": {
    "successful": 2,
    "total": 3
  }
}

The following endpoint returns counts for verification requests and credit report pulls for billing purposes.

GET /api/v1/billing

Query Parameters

Parameter	Default	Description
from_date	Earliest date	Optional, date in `yyyy-mm-dd` format. Data is pulled from the beginning of this date.
to_date	Current date	Optional, date in `yyyy-mm-dd` format. Data is pulled through the end of this date.

The parameters from_date and to_date are optional. The date should be in yyyy-mm-dd format.

If the from_date parameter is missing or unparseable, all data will be included up to the to_date. If the to_date parameter is missing or unparseable, data will be included from the from_date to the present. If neither parameter is present or parseable, all data will be included.

If you have multiple API types enabled, the response will contain a count for each type. This endpoint returns only verification request and credit report pull counts. Specific pricing information is available on request.