GET
/
background-checks
/
{backgroundCheckId}
/
records
Get background check records
curl --request GET \
  --url https://api.syntage.com/background-checks/{backgroundCheckId}/records \
  --header 'X-API-Key: <api-key>'
{
  "@context": "<string>",
  "@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records/82cd9012-3456-7890-abcd-ef1234567890",
      "@type": "BackgroundCheckRecord",
      "id": "82cd9012-3456-7890-abcd-ef1234567890",
      "category": "criminal_record",
      "database": {
        "id": "55f01234-5678-9012-cdef-345678901234",
        "name": "Mexico Criminal Records Database",
        "country": "MX"
      }
    }
  ],
  "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": "<string>",
    "hydra:template": "/background-checks/91ab5678-1234-5678-9abc-def012345678/records{?category}",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "IriTemplateMapping",
        "variable": "category",
        "property": "category",
        "required": false
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
backgroundCheckId
string<uuid>
required

The background check ID

Query Parameters

​
id[lt]
string

The collection cursor pointer to the next page

​
id[gt]
string

The collection cursor pointer to the previous page

​
itemsPerPage
integer
default:20

The number of items per page

Required range: 1 <= x <= 1000
​
category
enum<string>

Filter background check records by 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[createdAt]
enum<string>

Order by resource creation date

Available options:
asc,
desc
Example:

"asc"

​
order[updatedAt]
enum<string>

Order by resource update date

Available options:
asc,
desc
Example:

"asc"

Response

Background Check Records

​
@context
string
default:/contexts/BackgroundCheckRecord
​
@id
string
Example:

"/background-checks/91ab5678-1234-5678-9abc-def012345678/records"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:view
object

Pagination information

​
hydra:search
object