Background check service
The background search service is a solution to search for companies and individuals against public compliance lists for the Prevention of Money Laundering and Financing of Terrorism (PLD / FT).
Endpoint
The characteristics of the endpoints for the consumption of the background check service of individuals and companies are listed below.
Physical person
This method filters individuals against public compliance lists for the Prevention of Money Laundering and Financing of Terrorism (PLD / FT).
~/api/BackgroundCheck/physicalPerson
Parameters
Name |
Type |
Required |
Description |
name |
string |
yes |
Name(s) of the person without accents or special characters. |
lastName |
string |
yes |
Last name without accents or special characters. |
secondLastName |
string |
yes |
Second last name without accents or special characters. |
rfc |
string |
no |
RFC with homoclave of the person. |
curp |
string |
no |
CURP (Clave Única de Registro de Población). |
dateOfBirth |
string |
no |
Date of birth. |
Name |
Type |
Required |
Description |
ApiKey |
string |
yes |
Access credentials |
{
"name": "string",
"lastName": "string",
"secondLastName": "string",
"rfc": "string",
"curp": "string",
"dateOfBirth": "string"
}
Response:
Correct
Name |
Type |
Description |
found |
boolean |
Success |
coincidenceResult |
string |
Level of coincidence between the input parameters and the results obtained. |
name |
string |
Name (s) of the person. |
lastName |
string |
Last name. |
secondLastName |
string |
Mother's last name. |
rfc |
string |
RFC with homoclave of the person. |
curp |
string |
CURP (Clave Única de Registro de Población). |
dateOfBirth |
string |
Date of birth. |
list |
string |
List on which a match was found. |
completeName |
string |
Complete name of the person. |
sex |
string |
Sex of the person. |
email |
string |
Mail of the person. |
{
"found": 'success',
"coincidences": [{
"coincidenceResult": integer,
"name": string,
"lastName": string,
"secondLastName": string,
"rfc": string,
"curp": string,
"dateOfBirth": string,
"list": string,
"sex": string,
"email": string,
}]
}
Error
Code |
Description |
Error code |
If there are errors, they will be listed. |
Message |
Error message |
{
"code": "string",
"message": "string"
}
Juridical person
This method searches for legal entities against public compliance lists for the Prevention of Money Laundering and Financing of Terrorism (PLD / FT).
~/api/BackgroundCheck/juridicalPerson
Parameters
Name |
Type |
Required |
Description |
businessName |
string |
yes |
Business name |
rfc |
string |
no |
RFC with homoclave of the company. |
Name |
Type |
Required |
Description |
ApiKey |
string |
yes |
Access credentials |
{
"businessName": "string",
"rfc": "string"
}
Response:
Correct
Name |
Type |
Description |
found |
boolean |
Success |
coincidenceResult |
string |
Level of coincidence between the input parameters and the results obtained. |
list |
string |
Name of the public list where records of juridical person were found. |
wantedBy |
string |
Additional registration information. |
businessName |
string |
Business name of the juridical person. |
program |
string |
Program name of the juridical person. |
personType |
string |
PM (Juridical person) |
email |
string |
mail of the company. |
{
found: 'success',
coincidences: [{
"coincidenceResult": string,
"completeName": string,
"rfc": string,
"program":string,
"list": string,
"wantedBy": string,
"email": string
}]
}
Error
Code |
Description |
Error code |
If there are errors, they will be listed. |
{
"code": "string",
"message": "string"
}
Service messages
Code |
Message |
Description |
BGC001 |
Something was wrong, We are working on the failure. |
Indicates if the request was successful. If all goes well, it will show the structure of the data. |
BGC002 |
Unauthorized at BGC Services |
Message that is displayed when a request is sent with empty fields: Name, lastname, second last name and RFC. |
BGC003 |
BGC Services Timeout Error |
Message that is displayed when the server takes a long time to deliver a response and cannot be obtained. |
BGC004 |
BGC service is not available |
Message displayed when there is an error getting the response from the server. |
BGC005 |
Unable to validate data with source |
The service has issues to validate data in the source. |
BGC006 |
BGC Document Timeout Error |
Message that is displayed when the server takes a long time to deliver a response and cannot be obtained. |
BGC007 |
Parameter error |
The request has an error in some of the values in the parameters. |
BGC008 |
The apiKey is not valid. |
The apiKey is not valid. |
BGC009 |
ApiKey is required |
The ApiKey was not sent in the request. |