curl --request GET \
--url https://api.syntage.com/background-checks/{id} \
--header 'X-API-Key: <api-key>'
{
"@context": "<any>",
"@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678",
"@type": "BackgroundCheck",
"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": "<string>",
"resource": "<string>",
"mimeType": "<string>",
"extension": "<string>",
"size": 40544,
"filename": "<string>",
"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"
}
Retrieves detailed information about a specific background check, including scores, database statuses, and associated files.
curl --request GET \
--url https://api.syntage.com/background-checks/{id} \
--header 'X-API-Key: <api-key>'
{
"@context": "<any>",
"@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678",
"@type": "BackgroundCheck",
"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": "<string>",
"resource": "<string>",
"mimeType": "<string>",
"extension": "<string>",
"size": 40544,
"filename": "<string>",
"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"
}
Your API key is available in the Production and Sandbox dashboards.
Background Check
The response is of type object
.