Intro

This API lets you request a person and validate its compliance with control lists against Prevención de Lavado de Dinero (PLD) and terrorist financing, ensuring effective and accurate detection.

Important points

Parameters

To make the request it is necessary to provide the following parameters in the request.

field	type	required	Description
nombres	Alphabetic	Yes	Provide the name of the person to consult.
apellidoPaterno	Alphabetic	Yes	Indicate the individual's first surname.
apellidoMaterno	Alphabetic	No	Indicate the individual's second surname.
vault	Alphabetic	Yes	Provide the name of the vault secret where you have configured your access credentials for the Círculo de crédito services. For more information please visit our knowledge center to know more about vault secrets.

Response

You can find examples of the various response types within the call's examples.

Test the service (test cases)

We included a query param in Sandbox environment, so you can query test cases that we created to run tests.
In order to obtain the response, please fill the query param with:

success: it sends back a successful response
not_found: it sends back a response indicating that the person could not be found in the PLD lists

Possible Errors

Empty fields

You will get a 400 bad request error when any of the required parameters were not provided.

[
    {
        "code": "EMPTY_ERROR",
        "message": "can't be empty",
        "field": "nombres"
    },
    {
        "code": "EMPTY_ERROR",
        "message": "can't be empty",
        "field": "apellidoPaterno"
    },
    {
        "code": "EMPTY_ERROR",
        "message": "can't be empty",
        "field": "vault"
    }
]

Vaul secret not found

You will get a 404 Not Found error when the provided secret was not found the vault section

{
    "typeError": "ELEMENT_NOT_EXIST_ERROR",
    "errors": {},
    "errorMessage": "vault not was found"
}

Test case not found

if a test case parameter is not sent or a value other than those mentioned above is sent, the service will return the following error 400 bad request

[
    {
        "code": "EMPTY_ERROR",
        "message": "test case not found with given id",
        "field": "testCaseId"
    },
    {
        "code": "EMPTY_ERROR",
        "message": "test case not found",
        "field": "testCase"
    }
]