Retrieve a Check

This endpoint allows you to check the status of a background check. If the check is completed, you can also retrieve the PDF report with the results.

GET https://api.zapsign.com.br/api/v1/checks/{{check_id}}/

Path parameters

Nombre	Tipo	Descripción
check_id	string	The unique identifier of the check

Header

Nombre	Tipo	Descripción
Authorization*	string	API token prefixed with the word "Bearer". Example: Bearer c7f35c84-xxxx

Check Status Values

Status	Description
not_started	The check is in the queue and data collection has not started yet.
in_progress	Some data sources are still being processed.
delayed	One or more data sources are taking longer than expected, although most have finished.
error	The check has ended with more than 30% of data sources resulting in an error.
completed	70% or more of the data sources have successfully completed, or most did not return an error.

Response

{
    "check_id": "CHK41dd253a3e9c018f3d4ee062ac98b091",
    "status": "completed",
    "company_name": "",
    "full_name": "MARIA",
    "last_name": "PEREZ",
    "date_of_birth": null,
    "issue_date": null,
    "national_id": "11111111",
    "passport": "",
    "native_national_id": "",
    "pep": "",
    "ptp": "",
    "foreign_id": "",
    "tax_id": "",
    "country": "CO",
    "native_country": "",
    "check_type": "person",
    "lang": "en",
    "region": "",
    "pdf_report": {
        "status": "completed",
        "url": "https://zapsign.s3.amazonaws.com/2025/4/truora/92001eac-2d94-4115-95d9-ef205693a7d0.pdf?AWSAccessKeyId=AKIASSSZJ7JCTI2ZRGWX&Signature=VddqJfz0B64a9VcWeeewDp8Gca4%3D&Expires=1743787456"
    },
    "created_at": "2025-04-02T20:09:47.017891Z",
    "last_update_at": "2025-04-02T20:24:15.872207Z"
}