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.
lastName string yes Last name.
secondLastName string yes Second last name.

Headers

Name Type Required Description
ApiKey string yes Access credentials

Formdata

{
  "name": "string",
  "lastName": "string",
  "secondLastName": "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.
status string Additional registration information. Example: ACTIVE.
completeName string Complete name of the person.
surnames string Paternal surname and maternal surname of the person.
sex string Sex of the person.
personType string PF (physical person).
{
    "found": 'success',
    "coincidences": [{
        "coincidenceResult": integer,
        "name": string,
        "lastName": string,
        "secondLastName": string,
        "rfc": string,
        "curp": string,
        "dateOfBirth": string,
        "list": string,
        "status": string,
        "completeName": string,
        "surnames": string,
        "sex": string,
        "personType": 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

Headers

Name Type Required Description
ApiKey string yes Access credentials

FormData

{
  "businessName": "string"
}

Response:

Correct

Name Type Description
found boolean Success
coincidenceResult string Level of coincidence between the input parameters and the results obtained.
incorporationDate string Incorporation date of the juridical person (default format yyyy-MM-dd).
list string Name of the public list where records of juridical person were found.
status string Additional registration information.
businessName string Business name of the juridical person.
personType string PM (Juridical person)
{
    found: 'success',
    coincidences: [{
        "coincidenceResult": string,
        "rfc": string,
        "incorporationDate": string,
        "list": string,
        "status": string,
        "businessName": string,
        "personType": string
    }]
}

Error

Code Description
Error code If there are errors, they will be listed.
{
    "code": "string",
    "message": "string"
}

Service messages

Code Message Description
200 N/A Indicates if the request was successful. If all goes well, it will show the structure of the data.
400 $ or $ values cannot contain blanks. Message that is displayed when a request is sent with empty fields: Name, lastname, second last name and RFC.
400 $ or $ values cannot contain blanks. Message that is displayed when a request is sent with empty fields: Name, lastname, mother's last name and business name.
200 { "found": false, "coincidences": [] } If the request was unsuccessful. If no match is found, it will display the indicated structure.
400 The number of characters must not be greater than $ or $ Message that is displayed when more characters are entered than allowed in the fields.
401 The apikey is not valid Message that is shown when the api key is incorrect.
400 You must enter correct values to perform the query Message that is displayed when incorrect characters are sent.
500 Error in server response Message displayed when there is an error getting the response from the server.
504 Response time has exceeded Message that is displayed when the server takes a long time to deliver a response and cannot be obtained.