Skip to main content
GET
/
entities
/
{entityId}
/
background-checks
List an entity's background checks
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/background-checks \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/BackgroundCheck",
  "@id": "/entities/91ab5678-1234-5678-9abc-def012345678/background-checks",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "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",
      "@id": "/background-checks/91ab5678-1234-5678-9abc-def012345678",
      "@type": "BackgroundCheck"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": "<string>",
    "hydra:next": "<string>",
    "hydra:last": "<string>"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
entityId
string<uuid>
required

Query Parameters

​
id[lt]
string

Collection cursor pointer to the next page

​
id[gt]
string

Collection cursor pointer to the previous page

​
itemsPerPage
integer
default:20

Number of items per page

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

Filter background checks by status Status of the background check:

  • pending: Background check is being processed
  • completed: Background check has been completed successfully
  • error: Background check encountered an error during processing
Available options:
pending,
completed,
error
Example:

"completed"

​
country
enum<string>

Filter background checks by country Country scope for background check:

  • MX: Mexico-specific background checks
  • ALL: International background checks across multiple countries
Available options:
MX,
ALL
Example:

"MX"

​
order[score]
enum<string>

Order by background check score

Available options:
asc,
desc
Example:

"asc"

​
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

Entity Background Checks

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

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

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

Total number of items found

Required range: x >= 0
Example:

1

​
hydra:view
object

Pagination information

​
hydra:search
object