Get a specific background check

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string<uuid>

required

Response

Background Check

string<uuid>

required

Example:

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

link

string<iri-reference>

required

Entity link

Example:

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

country

enum<string>

required

Country scope for background check:

MX: Mexico-specific background checks
ALL: International background checks across multiple countries

Available options:

MX,

ALL

Example:

"MX"

score

number<float>

required

Overall background check score

Example:

85.5

status

enum<string>

required

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"

scores

object[]

required

Detailed scores by category

Show child attributes

scores.id

string<uuid>

required

Example:

"73de0123-4567-8901-bcde-f23456789012"

scores.category

enum<string>

required

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"

scores.score

number<float>

required

Score for this category

Example:

92.3

scores.status

string

required

Status of this category check

Example:

"clean"

scores.recordsCount

integer

required

Number of records found for this category

Example:

3

databaseStatuses

object[]

required

Status information for each database checked

Show child attributes

databaseStatuses.id

string<uuid>

required

Example:

"64ef1234-5678-9012-cdef-345678901234"

databaseStatuses.database

object

required

Show child attributes

databaseStatuses.database.id

string<uuid>

required

Example:

"55f01234-5678-9012-cdef-345678901234"

databaseStatuses.database.name

string

required

Display name of the database

Example:

"Mexico Criminal Records Database"

databaseStatuses.database.country

enum<string>

required

Country scope for background check:

MX: Mexico-specific background checks
ALL: International background checks across multiple countries

Available options:

MX,

ALL

Example:

"MX"

databaseStatuses.category

enum<string>

required

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"

databaseStatuses.status

string

required

Status of the database check

Example:

"completed"

files

object[]

required

Associated files including PDF reports

Show child attributes

files.@id

string<iri-reference>

File IRI reference

Example:

"/files/91106968-1abd-4d64-85c1-4e73d96fb997"

files.@type

string

default:File

files.id

string<uuid>

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

files.type

string

files.resource

string

files.mimeType

string

files.extension

string

files.size

integer

Example:

40544

files.filename

string

files.createdAt

string

Date and time the resource was created

Example:

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

files.updatedAt

string

Date and time the resource was last updated

Example:

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

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

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

Get a specific background check

Authorizations

Path Parameters

Response