Using This Guide
Hold on there, Skippy! Before you begin using our spectacular API documentation, please take a moment to read the manual. I know, who needs a manual, am I right?? You do. Or at least we think it would be really helpful.
Recommended Use
After you receive your developer credentials, we suggest you move through our Quick Start Guide section by section. We've ordered the content in a manner which mimics how users implement our solution. Follow this guide and you shouldn't have any issues understanding how to use our platform. But if you do, fear not! Our team of top notch support engineers is ready and waiting to help. Please reach out to our support team at [email protected]
API Request Examples
Within the API documentation, we use a colon and name value (:org_id) to identify fields you'll replace with your content. In the example below, you'd replace ":org_id" with your Validic Organization ID.
This format is normally used to identify these fields:
| Field | Description | Origin | Example |
|---|---|---|---|
| :org_id | The unique ID defining your organization in the Validic platform. | Provided by Validic. Please contact your Account Manager if you do not have this ID. | 597752338a5da500014a1f9a |
| :uid | The unique ID that defines an individual in the Validic platform. | Provided by you. | xyz123a |
| :token | The API access token which, combined with the org_id, grants access to the Validic API. :token can be passed as a query parameter or as part of the header. | Provided by Validic. | d477fr988d9dca76520e6a3c |
| :ID | Identifying number which indicates which stream to return. | Provided by Validic in response to a request. | d477fr988d9dca76520e6a3c |
Updated over 4 years ago