List background check records
curl --request GET \
--url https://api.syntage.com/background-checks/{backgroundCheckId}/records \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.syntage.com/background-checks/{backgroundCheckId}/records"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.syntage.com/background-checks/{backgroundCheckId}/records', 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.syntage.com/background-checks/{backgroundCheckId}/records",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.syntage.com/background-checks/{backgroundCheckId}/records"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntage.com/background-checks/{backgroundCheckId}/records")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntage.com/background-checks/{backgroundCheckId}/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"@context": "/contexts/BackgroundCheckRecord",
"@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records",
"@type": "hydra:Collection",
"hydra:member": [
{
"id": "82cd9012-3456-7890-abcd-ef1234567890",
"category": "criminal_record",
"database": {
"id": "55f01234-5678-9012-cdef-345678901234",
"name": "Mexico Criminal Records Database",
"country": "MX"
},
"sections": [
{
"id": "46ef1234-5678-9012-cdef-345678901234",
"title": "Personal Information",
"fields": [
{
"id": "37ef1234-5678-9012-cdef-345678901234",
"name": "Full Name",
"value": "Juan Manuel Perez Gonzalez"
}
]
}
],
"title": "Criminal records",
"@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records/82cd9012-3456-7890-abcd-ef1234567890",
"@type": "BackgroundCheckRecord"
}
],
"hydra:view": {
"@id": "<string>",
"@type": "hydra:PartialCollectionView",
"hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
"hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records{?category}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "category",
"property": "category",
"required": false
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}Background Checks
List background check records
Lists the records found during a background check. Records contain the detailed source data behind the check and are organized by category and database.
GET
/
background-checks
/
{backgroundCheckId}
/
records
List background check records
curl --request GET \
--url https://api.syntage.com/background-checks/{backgroundCheckId}/records \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.syntage.com/background-checks/{backgroundCheckId}/records"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.syntage.com/background-checks/{backgroundCheckId}/records', 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.syntage.com/background-checks/{backgroundCheckId}/records",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.syntage.com/background-checks/{backgroundCheckId}/records"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntage.com/background-checks/{backgroundCheckId}/records")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntage.com/background-checks/{backgroundCheckId}/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"@context": "/contexts/BackgroundCheckRecord",
"@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records",
"@type": "hydra:Collection",
"hydra:member": [
{
"id": "82cd9012-3456-7890-abcd-ef1234567890",
"category": "criminal_record",
"database": {
"id": "55f01234-5678-9012-cdef-345678901234",
"name": "Mexico Criminal Records Database",
"country": "MX"
},
"sections": [
{
"id": "46ef1234-5678-9012-cdef-345678901234",
"title": "Personal Information",
"fields": [
{
"id": "37ef1234-5678-9012-cdef-345678901234",
"name": "Full Name",
"value": "Juan Manuel Perez Gonzalez"
}
]
}
],
"title": "Criminal records",
"@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records/82cd9012-3456-7890-abcd-ef1234567890",
"@type": "BackgroundCheckRecord"
}
],
"hydra:view": {
"@id": "<string>",
"@type": "hydra:PartialCollectionView",
"hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
"hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records{?category}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "category",
"property": "category",
"required": false
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Your API key is available in the Production and Sandbox dashboards.
Path Parameters
The background check ID
Query Parameters
Collection cursor pointer to the next page
Collection cursor pointer to the previous page
Number of items per page
Required range:
1 <= x <= 1000Filter background check records by category Category of background check:
- personal_identity: Identity verification and personal information
- criminal_record: Criminal background and legal history
- legal_background: Legal proceedings and court records
- business_background: Business registration and commercial activity
- professional_background: Professional licenses and certifications
- credit_history: Credit and financial history
- taxes_and_finances: Tax compliance and financial records
- affiliations_and_insurances: Professional affiliations and insurance records
- driving_licenses: Driving licenses and vehicle permits
- vehicle_information: Vehicle ownership and registration
- vehicle_permits: Vehicle permits and registrations
- traffic_fines: Traffic violations and fines
- alert_in_media: Media mentions and public records
- behavior: Behavioral patterns and risk indicators
- international_background: International records and verification
- politically_exposed_person: PEP (Politically Exposed Person) screening
- document_validation: Document authenticity verification
- unknown: Unknown or unclassified category
Available options:
affiliations_and_insurances, alert_in_media, behavior, business_background, criminal_record, driving_licenses, international_background, legal_background, personal_identity, professional_background, traffic_fines, vehicle_information, vehicle_permits, taxes_and_finances, politically_exposed_person, credit_history, document_validation, unknown Example:
"criminal_record"
Order by resource creation date
Available options:
asc, desc Example:
"asc"
Order by resource update date
Available options:
asc, desc Example:
"asc"
Response
Background Check Records
Example:
"/background-checks/91ab5678-1234-5678-9abc-def012345678/records"
Show child attributes
Show child attributes
Pagination information
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?