Versium REACH API services share a few common outputs that are returned for all Versium APIs. To see sample results, go to Make Your First API Call .
| Output name | Description |
|---|---|
| version | The version of the API service used. |
| query_id | An ID unique to each query, useful if you need to troubleshoot. |
| results | Contains the results of the API call - this is the information you've asked for. |
| input_query | Shows the inputs and options you used to make the API call |
| num_results | Gives the number of match records for the given search parameters |
| query_time | How long the API call lookup took |
| num_matches | The total number of matches returned by the API |
| match_counts | Object containing the number of matches for each output type |
| errors | An array of error messages - only present if the API returns any error |
Output Example
Here's an example of the output you can expect:
{
"versium": {
"version":"2.0",
"match_counts":{
"address":1,
"email":1
},
"num_matches":1,
"num_results":1,
"query_id":"48f9238a-ba98-4c45-97df-74f405c97527",
"query_time":7.340619087219238,
"results":[
{
"First Name":"Veronica",
"Last Name":"Queck",
"Address":"18804 10TH PL W",
"City":"Kirklan",
"State":"WA",
"Zip":"98033",
"Country":"US",
"Email Address":"[email protected]"
}
],
"input_query":{
"first":"veronica"
"last":"queck"
"zip":"98117"
}
}
}