ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Creating a Background Check

Company check

PreviousPerson CheckNextRetrieve a Check

Last updated 9 days ago

Was this helpful?

This endpoint is used to create a company background check or company credit history check.

Important: To request a credit history check for a company in Colombia, please to activate this feature.

POST https://api.zapsign.com.br/api/v1/checks/

Header

Nombre
Tipo
Descripción

Authorization*

string

API token prefixed with the word "Bearer". Example: Bearer c7f35c84-xxxx

Reqeust Body

Nombre
Tipo
Descripción

country*

string

type*

string

user_authorized*

boolean

Indicates whether the company authorized the check. Must be true to proceed.

force_creation

boolean

If true, forces the creation of a new background check even if a result already exists. If false, returns the previously created check result if available.

tax_id*

string

Official company identification number (e.g., RUT, CNPJ, RFC).

company_name

string

Company name. If provided, international databases will be consulted for more detailed results.

observers

array<string>

Represents background check observers (limit 20), i.e. email addresses that will be notified when the background check is completed. It's an array of strings.

Each background check has an additional cost depending on the type of check. To top up your account, go to your user dashboard and navigate to Plans and Pricing > Credits.

Company check in CO, BR, CL, and PE: 90 credits (USD $1.80)

Company check in MX: 130 credits (USD $2.60)

Company credit history check in CO and BR: 200 credits (USD $4.00)

Request

{
    "user_authorized": true,
    "force_creation": true,
    "type": "company",
    "country": "CO",
    "taxl_id": "11111111"
}

Response

{
    "check_id": "CHK682a755bb7135140248cc8dd1d290a01",
    "status": "not_started",
    "company_name": "",
    "full_name": "",
    "first_name": "",
    "last_name": "",
    "date_of_birth": null,
    "issue_date": null,
    "national_id": "",
    "foreign_id": "",
    "tax_id": "1111111",
    "country": "CO",
    "native_country": "",
    "check_type": "company",
    "lang": "es",
    "region": "",
    "created_at": "2025-03-28T17:49:43.363416Z",
    "last_update_at": "2025-03-28T17:49:43.363435Z"
}

Reminder: The results of a check may take between 2 and 20 minutes. To retrieve the results, you can use:

BR | CO | MX . Más detalle de consultas disponibles

Type of check: company", "credit_company_co", "credit_company_br". for more details.

The endpoint

The endpoint

The webhook

contact the sales team
Check Details
Retrieve Check
Check Completed
haz clic aqui
Click here