Person Check
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint is used to create a person check or personal credit history check. The parameters you need to send will depend on the country and the type of check. There are also optional parameters that can improve the results by querying additional databases and filtering homonyms in some cases.
Important: To request a credit history check for a persona in Colombia, please to activate this feature.
POST https://api.zapsign.com.br/api/v1/checks/
Authorization*
string
API token prefixed with the word "Bearer". Example: Bearer c7f35c84-xxxx
country*
string
type*
string
Type of check: "person", "credit_person_co", "credit_person_br",
user_authorized*
boolean
Indicates whether the person authorized the check. Must be true to proceed.
force_creation
boolean
If true, forces the creation of a new background check even if one already exists. If false, returns the result of the previous check (if available).
first_name
string
Person's first name. If provided, international databases will be consulted for more detailed results.
last_name
string
Person's last name. Same behavior as first_name.
national_id
string
Official ID number. You must send either national_id, foreign_id, ptp, or ppt.
foreign_id
string
Foreigner ID document. Available for CO, CL, MX, PE.
ptp
string
Temporary Protection Permit. Only available for PE.
ppt
string
Temporary Protection Permit. Only available for CO.
state_id
string
RG (Registro Geral) en Brasil. Esta RG (General Registry) in Brazil. Format varies by issuing state. Required for full background checks in Brazil.
date_of_birth
string
Date of birth in YYYY-MM-DD format. Required for foreigners in CL and CO, and for official documents in PE and BR. In other cases, it helps provide more accurate results.
region
string
Required for BR. Region for the background check. Use a specific state or ALL for a national search. National searches may take up to 24 hours; regional searches take 2–20 minutes.
DF | AC | AL | AP | AM | BA | CE | ES | GO | MA | MT | MS | MG | PA | PB | PR | PE | PI | RJ | RN | RS | RO | RR | SC | SP | SE | TO | ALL
issue_date
DateTime
Document issue date in YYYY-MM-DD format. Applies to CL (national_id) and CO (national_id and foreign_id).
custom_input
string
Optional external identifier for reference (max 128 characters).
verification_code
string
Verification code for criminal records in PE and CL.
issue_number
string
Chilean ID document issue number. Used to get additional information. Only applies to Chile.
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.
Note: Each background check incurs an additional cost depending on the check type. You can top up your balance in your account under: Plans and Pricing > Credits
Person check in CO, BR, CL, PE: 90 credits (USD $1.80)
Person check in MX: 130 credits (USD $2.60)
Person credit history check CO and BR: 200 credits (USD $4.00)
Example Request
Reminder: The results of a check may take between 2 and 20 minutes. To retrieve the results, you can use:
BR | CO | CL | MX | PE. Más detalle de consultas disponibles
for more detail
The endpoint
The endpoint
The webhook