Start an ownership search
curl --request POST \
--url https://api.govfiles.dev/v2/local-businesses/batches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"locations": [
{
"name": "<string>",
"address": "<string>",
"customer_record_id": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>"
}
]
}
'import requests
url = "https://api.govfiles.dev/v2/local-businesses/batches"
payload = { "locations": [
{
"name": "<string>",
"address": "<string>",
"customer_record_id": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>"
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
locations: [
{
name: '<string>',
address: '<string>',
customer_record_id: '<string>',
phone: '<string>',
email: '<string>',
website: '<string>'
}
]
})
};
fetch('https://api.govfiles.dev/v2/local-businesses/batches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.govfiles.dev/v2/local-businesses/batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'locations' => [
[
'name' => '<string>',
'address' => '<string>',
'customer_record_id' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'website' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.govfiles.dev/v2/local-businesses/batches"
payload := strings.NewReader("{\n \"locations\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"customer_record_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.govfiles.dev/v2/local-businesses/batches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"locations\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"customer_record_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.govfiles.dev/v2/local-businesses/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"locations\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"customer_record_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"location_count": 250,
"created_at": "2023-11-07T05:31:56Z",
"status": "queued",
"type": "local_business_batch"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Local business ownership
Start an ownership search
POST
/
v2
/
local-businesses
/
batches
Start an ownership search
curl --request POST \
--url https://api.govfiles.dev/v2/local-businesses/batches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"locations": [
{
"name": "<string>",
"address": "<string>",
"customer_record_id": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>"
}
]
}
'import requests
url = "https://api.govfiles.dev/v2/local-businesses/batches"
payload = { "locations": [
{
"name": "<string>",
"address": "<string>",
"customer_record_id": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>"
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
locations: [
{
name: '<string>',
address: '<string>',
customer_record_id: '<string>',
phone: '<string>',
email: '<string>',
website: '<string>'
}
]
})
};
fetch('https://api.govfiles.dev/v2/local-businesses/batches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.govfiles.dev/v2/local-businesses/batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'locations' => [
[
'name' => '<string>',
'address' => '<string>',
'customer_record_id' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'website' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.govfiles.dev/v2/local-businesses/batches"
payload := strings.NewReader("{\n \"locations\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"customer_record_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.govfiles.dev/v2/local-businesses/batches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"locations\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"customer_record_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.govfiles.dev/v2/local-businesses/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"locations\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"customer_record_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"location_count": 250,
"created_at": "2023-11-07T05:31:56Z",
"status": "queued",
"type": "local_business_batch"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Submit up to 500 physical business locations for asynchronous operator resolution. Every accepted submission creates a new batch and returns
Save the returned
202 Accepted.
Every location must include name and address. You may optionally provide phone, email, and website to improve matching.
curl -s -X POST 'https://api.govfiles.dev/v2/local-businesses/batches' \
-H 'Content-Type: application/json' \
-H "X-API-Key: $GOVFILES_API_KEY" \
-d '{
"locations": [{
"customer_record_id": "location-123",
"name": "Example Kitchen",
"address": "105 Paramount Park Drive, Gaithersburg, MD 20879"
}]
}'
batch_id. Use it to poll the batch; the succeeded response includes the complete result JSON.
customer_record_id may be omitted or set to null. The API generates a unique value
and returns it with that location’s result.
See Local-business batches for input rules, states, result semantics, and billing.Authorizations
Body
application/json
Required array length:
1 - 500 elementsShow child attributes
Show child attributes
Response
Batch accepted and queued for asynchronous processing.
- Queued
- Running
- Succeeded
- Failed