Skip to main content
GET
/
background-checks
/
{id}
Retrieve a background check
curl --request GET \
  --url https://api.syntage.com/background-checks/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "91ab5678-1234-5678-9abc-def012345678",
  "link": "/entities/91ab5678-1234-5678-9abc-def012345678",
  "country": "MX",
  "score": 85.5,
  "status": "completed",
  "scores": [
    {
      "id": "73de0123-4567-8901-bcde-f23456789012",
      "category": "criminal_record",
      "score": 92.3,
      "status": "clean",
      "recordsCount": 3
    }
  ],
  "databaseStatuses": [
    {
      "id": "64ef1234-5678-9012-cdef-345678901234",
      "database": {
        "id": "55f01234-5678-9012-cdef-345678901234",
        "name": "Mexico Criminal Records Database",
        "country": "MX"
      },
      "category": "criminal_record",
      "status": "completed"
    }
  ],
  "files": [
    {
      "@id": "/files/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "File",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "type": "invoice.cfdi.xml",
      "resource": "/invoices/7c45e9c6-8f7f-4d0e-b6e5-65fef6c8c2f9",
      "mimeType": "text/xml",
      "extension": "xml",
      "size": 40544,
      "filename": "6f3c5312-2849-4525-86f6-c48a54c64c60.xml",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z",
  "@context": "<unknown>",
  "@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678",
  "@type": "BackgroundCheck"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Response

Background Check

​
id
string<uuid>
required

Unique background check ID

Example:

"91ab5678-1234-5678-9abc-def012345678"

​
link
string<iri-reference>
required

Entity associated with the background check

Example:

"/entities/91ab5678-1234-5678-9abc-def012345678"

​
country
enum<string>
required

Country scope for the background check

Available options:
MX,
ALL
Example:

"MX"

​
score
number<float>
required

Overall score returned by the background check provider

Example:

85.5

​
status
enum<string>
required

Processing status for the background check

Available options:
pending,
completed,
error
Example:

"completed"

​
scores
object[]
required

Scores returned for each background check category

​
databaseStatuses
object[]
required

Status information for each database checked by the provider

​
files
object[]
required

Files produced by the background check, including PDF reports when available

​
createdAt
string
required

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string
required

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

​
@context
any
​
@id
string<iri-reference>

Background Check IRI reference

Example:

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

​
@type
string
default:BackgroundCheck